Skip to content

Commit

Permalink
Update docs with arguments instead of options for cli
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewtavis committed Nov 28, 2024
1 parent c20d6b6 commit 703ffda
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +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 [command] [options]
scribe-data [command] [arguments]
```

### Available Commands
Expand Down
7 changes: 6 additions & 1 deletion USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,12 @@ To utilize the Scribe-Data CLI, you can execute the following command in your te
```bash
pip install scribe-data

scribe-data [command] [options]
# For a development build:
git clone https://github.com/scribe-org/Scribe-Data.git # or ideally your fork
cd Scribe-Data
pip install -e .

scribe-data [command] [arguments]
```

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

.. code-block:: shell
scribe-data [command] [options]
scribe-data [command] [arguments]
Available Commands
==================
Expand Down
8 changes: 4 additions & 4 deletions docs/source/scribe_data/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Usage:

.. code-block:: bash
scribe-data list [options]
scribe-data list [arguments]
Options:
^^^^^^^^
Expand Down Expand Up @@ -121,7 +121,7 @@ Usage:

.. code-block:: bash
scribe-data get [options]
scribe-data get [arguments]
Options:
^^^^^^^^
Expand Down Expand Up @@ -336,7 +336,7 @@ Usage:

.. code-block:: bash
scribe-data total [options]
scribe-data total [arguments]
Options:
^^^^^^^^
Expand Down Expand Up @@ -418,7 +418,7 @@ Usage:

.. code-block:: bash
scribe-data convert [options]
scribe-data convert [arguments]
Options:
^^^^^^^^
Expand Down

0 comments on commit 703ffda

Please sign in to comment.