diff --git a/README.md b/README.md index 948b1c53..1eee626d 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/USAGE.md b/USAGE.md index 3437bc0e..1ed2453b 100644 --- a/USAGE.md +++ b/USAGE.md @@ -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 diff --git a/docs/source/index.rst b/docs/source/index.rst index 8378799c..901023f8 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -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 ================== diff --git a/docs/source/scribe_data/cli.rst b/docs/source/scribe_data/cli.rst index f4583c26..3692307a 100644 --- a/docs/source/scribe_data/cli.rst +++ b/docs/source/scribe_data/cli.rst @@ -49,7 +49,7 @@ Usage: .. code-block:: bash - scribe-data list [options] + scribe-data list [arguments] Options: ^^^^^^^^ @@ -121,7 +121,7 @@ Usage: .. code-block:: bash - scribe-data get [options] + scribe-data get [arguments] Options: ^^^^^^^^ @@ -336,7 +336,7 @@ Usage: .. code-block:: bash - scribe-data total [options] + scribe-data total [arguments] Options: ^^^^^^^^ @@ -418,7 +418,7 @@ Usage: .. code-block:: bash - scribe-data convert [options] + scribe-data convert [arguments] Options: ^^^^^^^^