diff --git a/README.rst b/README.rst index abfcbd8..e7ee53b 100644 --- a/README.rst +++ b/README.rst @@ -90,43 +90,79 @@ Getting Started Use the `cmi` command-line interface to install and manage modular optional dependencies, known as `packs`, and to configure or execute user-defined workflows that combine multiple packs with optional post-installation steps, -known as `profiles`. To use `cmi`, you can run the following example commands: +known as `profiles`. You may consult our `online documentation `_ for more information, +tutorials, and API references. + +The ``-h`` flag is available for **all** cmi commands and subcommands. +It's highly recommended to use it wherever necessary. - Show available commands and options, +To display help for the main CLI, type .. code-block:: bash - cmi -h + cmi -h + cmi --help -List installed and available packs and profiles, +Display help for a specific subcommand with, .. code-block:: bash - cmi pack list - cmi profile list + cmi -h -Show details of a specific pack or profile, +Open the full online manual in a web browser by typing, .. code-block:: bash - cmi pack show - cmi profile show + cmi --manual -Install a pack or profile (by name or path), +To print information about available and installed packs, profiles, and examples, type, .. code-block:: bash - cmi install + cmi info -List and get installed examples, +To print information about packs, profiles, or examples, type .. code-block:: bash - cmi example list - cmi example (copy) + cmi info packs + cmi info profiles + cmi info examples + +To install packs or profiles into your environment, type + +.. code-block:: bash + + cmi install + cmi install + + +To copy an example or list of examples to cwd, type + +.. code-block:: bash + + cmi copy + cmi copy + +To copy all examples from a pack or list of packs to cwd, type + +.. code-block:: bash + + cmi copy + cmi copy + +To copy all examples to cwd, type + +.. code-block:: bash + + cmi copy all + +To show basic information about your current conda environment, type + +.. code-block:: bash + + cmi env -You may consult our `online documentation `_ for more information, -tutorials, and API references. Support and Contribute ---------------------- diff --git a/news/fix-readme-cli.rst b/news/fix-readme-cli.rst new file mode 100644 index 0000000..7f62bfe --- /dev/null +++ b/news/fix-readme-cli.rst @@ -0,0 +1,23 @@ +**Added:** + +* + +**Changed:** + +* Update command-line interface instructions in the README. + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +*