neetob 0.1.2 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3291bcfdc94bbfd6c2575e8fe48ab5e9a20e51e4bf935b5bf10199cce63adde
-  data.tar.gz: 42471a13f903e0fbb5d8d140ff570d86029e11a0617e40c4f52209ea27a1b7c3
+  metadata.gz: 641eee79e8d05537132030cc9db2ca8d4a57e60e480552dcb1a904fd00e542f5
+  data.tar.gz: a4c674222429b42cff84e1eeb7a66212b32da60f4248a36a4dae5b03439cc649
 SHA512:
-  metadata.gz: 7f4826cd0e5c4d6c94161091a70e68c794e2b2a83d1b0297fbfac37754af2d1cb0bb9e03ae4783f3b2f8d92a8f456576a4ae36891e5611d1e4e5fe7286fffb9a
-  data.tar.gz: 5db7526af2e260fae78e176d78531204c5e97b692ba5e0514c98108acc4294d30c8023372a2613097742edc75da9f4f1e3180d46b87d50878fc5f3554b4a9247
+  metadata.gz: 57951a8d15b4514b7468b7994094c42ff8b0786f6dee034091db26b71d909094c90235855f208a1b1bbc1cc4125add4a53afb6869e82e255baadbe22846220a7
+  data.tar.gz: e47da7744b3a4d92aa23881673f88d6cd9e1b795d92ddb67d0be5676229b82ea194b43125d0f8904bbf009c054f52884d1e5e43e2ecdff4d06eccea9e6bf227b

data/.rubocop.yml

@@ -1,6 +1,6 @@
 # cspell:Disable
 AllCops:
-  TargetRubyVersion: 3.0.4
+  TargetRubyVersion: 3.1.3
   # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
   # to ignore them, so only the ones explicitly set in this file are enabled.
   DisabledByDefault: true

data/.ruby-version

@@ -1 +1 @@
-3.0.4
+3.1.3

data/.semaphore/semaphore.yml

@@ -9,7 +9,7 @@ global_job_config:
   prologue:
     commands:
       - checkout
-      - sem-version ruby 3.0.4
+      - sem-version ruby 3.1.3
       - bundle config path 'vendor/bundle'
       - bundle install
   env_vars:
@@ -21,11 +21,10 @@ global_job_config:
       value: "test"
 
 blocks:
-  - name: Rails Tests
+  - name: Linters | Tests
     task:
       jobs:
-        - name: Rails Tests
+        - name: Checks
           commands:
-            - git clone https://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@github.com/bigbinary/neeto_compliance
-            - cd neeto_compliance/ && git checkout 3404e3dc33764a0f6d9c976c1cd73f9b56a1c913 && cd ..
+            - bundle exec rubocop
             - bundle exec rake test

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 ## [Unreleased]
 
+### [0.1.5](https://www.github.com/bigbinary/neetob/compare/v0.1.4...v0.1.5) (2023-03-01)
+
+
+### Bug Fixes
+
+* handled some edge cases in the update and upsert labels cmd ([#192](https://www.github.com/bigbinary/neetob/issues/192)) ([dc87d19](https://www.github.com/bigbinary/neetob/commit/dc87d198a6a22850f3e04659413bed41d9db454f))
+
+### [0.1.4](https://www.github.com/bigbinary/neetob/compare/v0.1.3...v0.1.4) (2023-02-23)
+
+
+### Bug Fixes
+
+* Fixed the readme ([#176](https://www.github.com/bigbinary/neetob/issues/176)) ([7770273](https://www.github.com/bigbinary/neetob/commit/7770273f7e11e7b8006dfc5e37f6746eb4229eb3))
+
+## 0.1.3 (2023-02-23)
+
+
+### Features
+
+* Added workflow to autorelease gem ([#156](https://www.github.com/bigbinary/neetob/issues/156)) ([bb7f5c9](https://www.github.com/bigbinary/neetob/commit/bb7f5c9081d0734f3a3086facbf28216a10151c3))
+
 ## [0.1.0] - 2022-10-28
 
 - Initial release

data/Gemfile

@@ -21,6 +21,16 @@ group :test do
   gem "minitest", "~> 5.0"
   gem "minitest-reporters"
   gem "mocha"
+  gem "rubocop", "~> 1.28"
   gem "simplecov"
   gem "webmock"
 end
+
+gem "byebug"
+gem "chronic"
+
+source "https://O6Ts9-SVDaUZpHMRs2CpJp22RwbETDE@gems.neeto.com" do
+
+  gem "neeto-compliance"
+
+end

data/Gemfile.lock

@@ -1,13 +1,21 @@
 PATH
   remote: .
   specs:
-    neetob (0.1.2)
+    neetob (0.1.5)
       dotenv (~> 2.8.1)
       launchy (~> 2.5.0)
       octokit (~> 4.0)
       terminal-table (~> 3.0.2)
       thor (~> 1.2.1)
 
+GEM
+  remote: https://O6Ts9-SVDaUZpHMRs2CpJp22RwbETDE@gems.neeto.com/
+  specs:
+    neeto-compliance (1.0.1)
+      colorize
+      hashdiff
+      json (~> 2.6.2)
+
 GEM
   remote: https://rubygems.org/
   specs:
@@ -81,8 +89,11 @@ GEM
     ansi (1.5.0)
     ast (2.4.2)
     builder (3.2.4)
+    byebug (11.1.3)
     childprocess (4.1.0)
+    chronic (0.10.2)
     coderay (1.1.3)
+    colorize (0.8.1)
     concurrent-ruby (1.1.10)
     crack (0.4.5)
       rexml
@@ -230,11 +241,14 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  byebug
+  chronic
   dotenv (~> 2.8.1)
   faraday-retry
   minitest (~> 5.0)
   minitest-reporters
   mocha
+  neeto-compliance!
   neetob!
   overcommit (~> 0.59.1)
   pry

data/README.md

@@ -1,12 +1,13 @@
 # neetob
 
-The `neetob` gem gives different commands for interacting with Github and Heroku instances of existing neeto projects.
+The `neetob` gem gives different commands for interacting with Github repos, Heroku instances and other tools to manage the workflow of neeto products.
 
 ## Table of Contents
 
-1. [Getting Started](#getting-started)
-   1. [Installation](#installation)
-2. [Usage](#usage)
+1. [Usage](#usage)
+   1. [Installing neetob for use](#installing-neetob-for-use)
+   2. [For development](#for-development)
+2. [Source of truth](#source-of-truth)
 3. [Working with GitHub](#working-with-github)
    1. [Issues](#issues)
    2. [Labels](#labels)
@@ -21,36 +22,22 @@ The `neetob` gem gives different commands for interacting with Github and Heroku
 5. [Working with Users](#working-with-users)
    1. [Audit](#audit)
    2. [Commits](#commits)
-6. [Working with Make Repos Uptodate](#working-with-make-repos-uptodate)
+6. [Make Repos Uptodate](#make-repos-uptodate)
 7. [Working with local Repos](#working-with-local-repos)
    1. [ls](#ls)
 8. [Testing](#testing)
 
-## Getting started
+## Usage
 
-### Installation
+### Installing neetob for use
 
-Clone the repository onto your system using the following command:
+Install and update the gem using the following command:
 
 ```sh
-git clone https://github.com/bigbinary/neetob.git
+gem install neetob && gem update neetob
 ```
 
-Navigate to the root of the application directory.
-
-```sh
-cd neetob
-```
-
-To set up `neetob`, execute the below command from the root of the application directory.
-
-```sh
-bin/setup
-```
-
-## Usage
-
-Utilize the `help` keyword to access a comprehensive list of all the available commands and options.
+Use the `help` keyword to access a list of all the available commands and options.
 
 ```
 neetob help
@@ -66,9 +53,7 @@ Options:
   [--sandbox] # All the commands in sandbox mode will run only on the "neeto-dummy" app.
 ```
 
-**By default, all commands will be executed in non-sandbox mode.**
-
-### Useful command-line options
+#### Useful command-line options
 
 | Option       | Meaning                           |
 | ------------ | --------------------------------- |
@@ -77,11 +62,85 @@ Options:
 | --no-sandbox | Non-Sandbox mode                  |
 | --help       | Provides information on a command |
 
-**Note:** The commands within `neetob` should be used with caution, as improper usage may result in unintended consequences, and some actions may not be reversible.
+The commands within `neetob` should be used with caution, as improper usage may result in unintended consequences, and some actions may not be reversible. By default, all commands will be executed in non-sandbox mode.
+
+### For development
+
+Clone the repository onto your system using the following command:
+
+```sh
+git clone https://github.com/bigbinary/neetob.git
+```
+
+Navigate to the root of the application directory.
+
+```sh
+cd neetob
+```
+
+To check and use the latest changes in the local repository install `neetob` like so:
+
+```sh
+bin/setup
+```
+
+We can use, check or debug the `neetob` locally by directly invoking the `neetob` class like so:
+
+```sh
+ruby exe/neeetob
+```
+
+#### Conventional commit messages
+
+In `neetob` we are using the Google's [release please](https://github.com/googleapis/release-please) Github action to auto update the version and release the latest gem.
+
+In order to make this action work we have to use the [conventional commit messages](https://www.conventionalcommits.org/en/v1.0.0/).
+
+The Conventional commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history.
+
+Generally, we use three types of suffix in the commit messages that are as follows:
+
+1. `fix:` for the commit that fixes a bug in the codebase. This updates the third digit in the version. For example, `0.1.0` version will be updated to `0.1.1`.
+
+2. `feat:` for the commit that introduces a new feature to the codebase. This updates the second digit in the version. For example, `0.1.0` version will be updated to `0.2.0`.
+
+3. `BREAKING CHANGE:` for the commit that introduces a breaking API change. This updates the first digit in the version. For example, `0.1.0` version will be updated to `1.0.0`.
+
+For more details please refer [official docs](https://www.conventionalcommits.org/en/v1.0.0/) from Conventional commits.
+
+In `neetob` we use "squash and merge" option while merging the PR. So we have to update the commit message while squash and merge so that Github action can track that merge commit.
+
+For example:
+
+![Commit message update](images/commit-message-update.png)
+
+## Source of truth
+
+This [list of repos](https://github.com/bigbinary/neeto-compliance/blob/main/data/neeto_repos.json) is used as the "source of truth".
+
+## Passing list of heroku apps as option
+
+`neetob` allows you to pass list of apps in the following three formats.
+
+```
+// all staging heroku instances
+--apps "neeto-*-staging"
+
+// all production heroku instances
+--apps "neeto-*-production"
+
+// all staging and production instances
+--apps "neeto-*-web"
+
+// for local testing
+--apps neeto-dummy
+```
+
+For safety reasons all the examples given below would be using `--apps neeto-*-staging`.
 
 ## Working with GitHub
 
-Efficiently gain access to a comprehensive list of all the available subcommands for the `github` command by utilizing the `help` keyword.
+Check the list of all the available subcommands for the `github` command by utilizing the `help` keyword.
 
 ```sh
 neetob github help
@@ -89,65 +148,79 @@ neetob github help
 
 ### Issues
 
-The `issues` command offers valuable insights into GitHub issues.
-
 ```sh
-# To efficiently list and count all the open issues that are currently unassigned
-neetob github issues list --count --state open --assignee none --apps "neeto-*-web"
+# Lists and counts all the open issues that are currently unassigned
+neetob github issues list --count --state open --assignee none --apps "neeto-*-staging"
 
-# To list, count and filter all unassigned open issues that are labeled as "bug" .
-neetob github issues list --count --label bug --state open --assignee none --apps "neeto-*-web"
+# Lists, counts and filters all unassigned open issues that are labeled as "bug"
+neetob github issues list --count --label bug --state open --assignee none \
+--apps "neeto-*-staging"
 ```
 
 ### Labels
 
-The `labels` command provides an intuitive interface for interacting with Github labels.
+The `labels` command provides an interface for interacting with Github labels.
 
 ```sh
-# The `list` command lists the details of all the labels in the Github repo.
-neetob github labels list --apps "neeto-*-web"
+# Lists the details of all the labels in the Github repo
+neetob github labels list --apps "neeto-*-staging"
 
-# The `show` command gives the details for a specific label in the Github repo.
-neetob github labels show --name priority --apps "neeto-*-web"
+# Provides the details for a specific label in the Github repo
+neetob github labels show --name priority --apps "neeto-*-staging"
 
-# The `update` command can be used to update the name of a label.
+# Changes the name of the label
 neetob github labels update --old-name "High Priority" --new-name \
-"high-priority" --apps neeto-dummy
+"high-priority" --all-neeto-repos
+
+# Updates and inserts all the labels mentioned in the file "data/github-labels.json"
+neetob github labels upsert --all-neeto-repos
 
-# The `upsert` command updates and inserts all the labels mentioned in default
-# labels JSON file that is "github-labels.json" file inside "data" directory.
-neetob github labels upsert --apps neeto-dummy
+# Accepts a different JSON file using `path` option
+neetob github labels upsert --path ~/Desktop/labels.json --apps "neeto-*-staging"
 
-# The `upsert` command can also be used with a different JSON file using `path` option.
-neetob github labels upsert --path ~/Desktop/labels.json --apps neeto-dummy
+# Upsert a single label using `name`, `color`, and `description` options
+# No `#` is required while adding `color`
+neetob github labels upsert --name UI --color 8250df --description \
+"UI work needed" --all-neeto-repos
 
-# The `delete` command deletes the given labels from the Github repos.
+# Deletes the given labels from the Github repos
 neetob github labels delete --labels "High Priority" "Priority 1" "bug" \
---apps neeto-dummy
+--apps "neeto-*-staging"
 
-# The `delete_all` command deletes all the labels from the Github repos.
-neetob github labels delete_all --apps neeto-dummy
+# Deletes all the labels from the Github repos
+neetob github labels delete_all --apps "neeto-*-staging"
 ```
 
 Check out the default labels [file](data/github-labels.json) for the required JSON file structure.
 
+Don't use `#` before the color code.
+
+```
+{
+  "name": "0.25D",
+  "description": "Estimate - 2 hours",
+  //"color": "#9E800A", // Wrong usage
+  "color": "9E800A" // Correct usage
+}
+```
+
 ### Search
 
-Easily search for keywords across multiple neeto projects within specified files by utilizing the `search` command.
+Searches for keywords across multiple neeto projects within specified files by utilizing the `search` command.
 
 ```sh
-neetob github search --keyword neeto --path README.md --apps "neeto-*-web"
+neetob github search --keyword neeto --path README.md --apps "neeto-*-staging"
 ```
 
 ### Protect branch
 
-Efficiently update branch protection rules across various neeto applications by utilizing the `protect_branch` command.
+Updates branch protection rules in neeto repos by using the `protect_branch` command.
 
 ```sh
-neetob github protect_branch --branch main --apps neeto-dummy
+neetob github protect_branch --branch main --apps "neeto-*-staging"
 ```
 
-By default, this [file](data/branch-protection-rules.json) will be used for updating the branch protection rules.
+By default, file "data/branch-protection-rules.json" will be used for updating the branch protection rules.
 
 The `protect_branch` command can also be used with a different JSON file using `path` option.
 
@@ -160,26 +233,36 @@ For example, assume we have a file named `branch-protection-rules.json` on the `
 }
 ```
 
-To update the above-mentioned branch protection rules for the `main` branch of all the neeto applications, use the following command:
+To update the above-mentioned branch protection rules for the `main` branch of all the neeto products, use the following command:
 
 ```sh
 neetob github protect_branch --branch main --path ~/Desktop/branch-protection-rules.json \
---apps neeto-dummy
+--apps "neeto-*-staging"
+```
+
+We can also use the `--all-neeto-repos` option with the above mentioned command so that the
+branch protection rules can be updated for
+all [neeto repos](https://github.com/bigbinary/neeto-compliance/blob/main/data/neeto_repos.json).
+
+```sh
+neetob github protect_branch --branch main --path ~/Desktop/branch-protection-rules.json \
+--all-neeto-repos
 ```
 
 **Note:** Unfortunately, utilizing the Github API, we are unable to update the `Require deployments to succeed before merging` rule, as it is currently not defined as a parameter within the API. For further information on available options to update different branch protection rules, kindly refer to the official Github [documentation](https://docs.github.com/en/rest/branches/branch-protection#update-branch-protection).
 
 ### Make PR
 
-The `make-pr` command can create pull requests across Github repos.
+The `make-pr` command creates pull requests across Github repos.
 
 ```sh
-# The `compliance-fix` command will do a `bundle` inside all repos and create a PR.
+# The `compliance-fix` command runs `bundle install` and
+# `bundle exec neeto-audit -a` inside all repos and create a PR.
 neetob github make-pr compliance-fix
 
-# The `script` command will run the given script for each product and create a PR.
+# The `script` command runs the given script for each product and create a PR
 neetob github make-pr script --path ~/Desktop/fix-folders.sh --branch "neetob-test" \
---title "PR title"
+--title "PR title" --description "PR description"
 ```
 
 ### Login
@@ -200,37 +283,37 @@ neetob heroku help
 
 ### Config vars
 
-The `config_vars` command is useful to interact with Heroku config variables.
+The `config_vars` command interacts with Heroku config variables.
 
 ```sh
-# The `list` command lists all the Heroku config variables.
-neetob heroku config_vars list --apps "neeto-*-production"
+# The `list` command lists all the Heroku config variables
+neetob heroku config_vars list --apps "neeto-*-staging"
 
-# We can list specific Heroku config variables using `keys` option.
-neetob heroku config_vars list --apps "neeto-*-production" --keys key1 key2  key3
+# List specific Heroku config variables using `keys` option
+neetob heroku config_vars list --apps "neeto-*-staging" --keys key1 key2  key3
 
-# We can also use a file to specify required config vars for `list` command
-# Checkout the `data/config-vars-list.json` file for the required structure.
-neetob heroku config_vars list --apps "neeto-*-production" --path \
+# List specific Heroku config variables using a file
+# Checkout the `data/config-vars-list.json` file for the required structure
+neetob heroku config_vars list --apps "neeto-*-staging" --path \
 neetob/data/config-vars-list.json
 
-# The `audit` command will check the config variables against the JSON file named as
+# The `audit` command checks the config variables against the JSON file named as
 # `required-config-vars.json` that is present inside the `data` directory at the root of
-# installed `neetob` gem.
-neetob heroku config_vars audit --apps "neeto-*-production"
+# installed `neetob` gem
+neetob heroku config_vars audit --apps "neeto-*-staging"
 
-# The `audit` command can also be used with a different JSON file using `--path` option.
-neetob heroku config_vars audit --path ~/Desktop/config.json --apps "neeto-*-production"
+# The `audit` command also works with a different JSON file using `--path` option
+neetob heroku config_vars audit --path ~/Desktop/config.json --apps "neeto-*-staging"
 
-# The `upsert` command adds or updates the config variables from the
-# `data/config-vars-upsert.json` file present at the root of installed `neetob` gem.
+# The `upsert` command adds or updates config variables from the
+# `data/config-vars-upsert.json` file present at the root of installed `neetob` gem
 neetob heroku config_vars upsert --apps "neeto-*-staging"
 
-# The `remove` command is used to delete `config_vars`.
+# The `remove` command deletes config variables
 neetob heroku config_vars remove --keys=TEST_KEY_1 TEST_KEY_2 --apps "neeto-*-staging"
 ```
 
-We can use a custom JSON file with `upsert` command using the `path` option.
+We can use a custom JSON file with `upsert` command using the `--path` option.
 
 For example, assume we have a file named `config.json` on the Desktop, like so:
 
@@ -242,13 +325,13 @@ For example, assume we have a file named `config.json` on the Desktop, like so:
 }
 ```
 
-To update the above-mentioned config variables to all staging apps, we can use the upsert command like so:
+To update the above-mentioned config variables to all staging apps, we can use the `upsert` command like so:
 
 ```sh
 neetob heroku config_vars upsert --path ~/Desktop/config.json --apps "neeto-*-staging"
 ```
 
-The `upsert` command can also be used to update and insert project-specific config variables.
+The `upsert` command can also update or insert project-specific config variables.
 
 For example, assume we have a file named `config.json` on the `Desktop` with the following properties:
 
@@ -269,76 +352,76 @@ For example, assume we have a file named `config.json` on the `Desktop` with the
 To update the above-mentioned config variables under the defined project, we can use the upsert command like so:
 
 ```sh
-neetob heroku config_vars upsert --path_with_project_keys ~/Desktop/config.json
+neetob heroku config_vars upsert --path_with_project_keys ~/Desktop/config.json --apps "neeto-*-staging"
 ```
 
 ### Access
 
-We can list, add, and remove users from multiple Heroku apps using the `access` command.
+The `access` command list, add and remove users from multiple Heroku apps.
 
 ```sh
-# The `list` command retrieves a list of all the users from Heroku apps.
-neetob heroku access list --apps "neeto-*-production"
+# List all the users from Heroku apps
+neetob heroku access list --apps "neeto-*-staging"
 
-# Add new users to the Heroku apps.
+# Add new users to the Heroku apps
 neetob heroku access add --users oliver@bigbinary.com eve@bigbinary.com --apps "neeto-*-staging"
 
-# Remove the users from the Heroku apps.
+# Remove the users from the Heroku apps
 neetob heroku access remove --users oliver@bigbinary.com eve@bigbinary.com --apps \
 "neeto-*-staging"
 ```
 
 ### Execute
 
-Utilize the `execute` command to run a Heroku CLI command or a Rails console command for multiple neeto apps in one go.
+The `execute` command executes a Heroku CLI command or a Rails console command for multiple neeto apps in one go.
 
 ```sh
-# We can check who has access to the neeto Heroku apps like so:
-neetob heroku execute -c "heroku access" --apps "neeto-*-production"
+# Execute Heroku CLI command
+neetob heroku execute -c "heroku access" --apps "neeto-*-staging"
 
-# We can run a command in the Rails console for different neeto Heroku apps like so:
+# Execute Rails console command
 neetob heroku execute -c "Sidekiq::Cron::Job.destroy \"server_side_worker\"" --apps \
 "neeto-*-staging" --rails
 ```
 
 ## Working with users
 
-Using the `users` command, we can interact with the contributors of neeto applications.
+The `users` command interacts with the contributors of neeto applications.
 
 ### Audit
 
-The `audit` command enables the ability to comprehensively audit contributors across all neeto applications by providing functionality to check for contributors with multiple emails and users with third-party domain emails.
-
-This command will search and use the neeto repos in the current working directory.
-To fetch and update all neeto repos execute [make_repos_uptodate](#working-with-make-repos-uptodate) command before the `audit` command.
+The `audit` command checks the contributors across all neeto applications for multiple emails and third-party domain emails.
 
 ```sh
+# Audit all the contributors
 neetob users audit
 ```
 
 ### Commits
 
-Using `commits` command we can list the commits for a user in a defined duration.
-
-This command will search and use the neeto repos in the current working directory.
-To fetch and update all neeto repos execute [make_repos_uptodate](#working-with-make-repos-uptodate) command before the `commits` command.
+The `commits` command lists the commits for a user in a defined duration.
 
 ```sh
 # The below mentioned command will open a list of all the commits across neeto
-# repos made by "udai1931" in the duration of last 6 months
+# product repos made by "udai1931" in the duration of last 6 months
 neetob users commits --author udai1931 --duration 6.months
 
-# We can list commits for a specific product using `--apps` option
+# List commits for a specific product using `--apps` option
 neetob users commits --author udai1931 --duration 6.months --apps neeto-kb-web
+
+# List commits for all neeto repos using the `--all-neeto-repos` option
+neetob users commits --author udai1931 --duration 6.months --all-neeto-repos
 ```
 
-## Working with Make Repos Uptodate
+## Make Repos Uptodate
 
-Using the `make_repos_uptodate` command, we can uptodate all neeto repos.
-The list of neeto repos is picked up from [neeto_compliance](https://github.com/bigbinary/neeto-compliance/blob/main/lib/neeto_compliance/neeto_repos.rb).
+The `make_repos_uptodate` command updates all neeto repos.
 
 ```sh
 neetob make_repos_uptodate
+
+# Update all neeto repos with `--all-neeto-repos`
+neetob make_repos_uptodate --all-neeto-repos
 ```
 
 Executing the above mentioned command will check and clone all the missing neeto repos in the current working directory and will update all of them to the latest version. After the execution of command the directories will look something like this:
@@ -351,25 +434,21 @@ neeto-kb-web
 
 ## Working with local Repos
 
-Using the `local` command, we can interact with the local neeto repos.
+The `local` command interacts with the local neeto repos.
 
 ### ls
 
-The `ls` command can list the files from all the local neeto repos.
-
-This command will search and use the neeto repos in the current working directory.
-To fetch and update all neeto repos execute [make_repos_uptodate](#working-with-make-repos-uptodate) command before the `ls` command.
+The `ls` command lists the files from all the local neeto repos.
 
 ```sh
-# The `ls` command will list all the files in the root directory of neeto repos.
-neetob local ls --apps "*"
+# List all the files in the root directory of neeto repos
+neetob local ls --apps "neeto-*-web"
 
-# The `ls` command can also list files in a specific directory using the
-# `--dir` option.
-neetob local ls --dir public --apps "*"
+# List files in a specific directory with `--dir` option
+neetob local ls --dir public --apps "neeto-*-web"
 
-# We can also list files in a nested directory.
-neetob local ls --dir app/controllers --apps "*"
+# List files in a nested directory
+neetob local ls --dir app/controllers --apps "neeto-*-web"
 ```
 
 ## Testing
@@ -378,4 +457,4 @@ For testing `github` commands use - [neeto-dummy](https://github.com/bigbinary/n
 
 For testing `heroku` commands use - [neeto-dummy](https://dashboard.heroku.com/apps/neeto-dummy) app.
 
-**Note:** Contact your respective Team Lead if you don't have access..
+**Note:** Contact your respective Team Lead if you don't have access.