Skip to content

Commit

Permalink
Add prompt for checking the help menu to the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewtavis committed Nov 28, 2024
1 parent 703ffda commit 4a348d4
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ Scribe-Data provides a command-line interface (CLI) for efficient interaction wi
To utilize the Scribe-Data CLI, you can execute variations of the following command in your terminal:

```bash
scribe-data -h # view the cli options
scribe-data [command] [arguments]
```

Expand Down
1 change: 1 addition & 0 deletions USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ git clone https://github.com/scribe-org/Scribe-Data.git # or ideally your fork
cd Scribe-Data
pip install -e .

scribe-data -h # view the cli options
scribe-data [command] [arguments]
```

Expand Down
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ To utilize the Scribe-Data CLI, you can execute variations of the following comm

.. code-block:: shell
scribe-data -h # view the cli options
scribe-data [command] [arguments]
Available Commands
Expand Down

0 comments on commit 4a348d4

Please sign in to comment.