From 9214fa5f2a593fdadd32f1813f7f5ab82a428f3f Mon Sep 17 00:00:00 2001 From: Caden Myers Date: Fri, 19 Dec 2025 15:17:07 -0600 Subject: [PATCH 1/4] copy cli info from docs to readme --- README.rst | 70 ++++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 57 insertions(+), 13 deletions(-) diff --git a/README.rst b/README.rst index abfcbd8..28d32a5 100644 --- a/README.rst +++ b/README.rst @@ -92,38 +92,82 @@ Use the `cmi` command-line interface to install and manage modular optional depe 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: - Show available commands and options, +The ``-h`` flag is available for **all** cmi commands and subcommands. +It's highly recommended to use it wherever necessary. + +To display help for the main CLI, type + +.. code-block:: bash + + cmi -h + cmi --help + +Display help for a specific subcommand with, + +.. code-block:: bash + + cmi -h + +Open the full online manual in a web browser by typing, .. code-block:: bash - cmi -h + cmi --manual -List installed and available packs and profiles, +To print information about available and installed packs, profiles, and examples, type, .. code-block:: bash - cmi pack list - cmi profile list + cmi info -Show details of a specific pack or profile, +To print information about packs, profiles, or examples, type .. code-block:: bash - cmi pack show - cmi profile show + 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 + -Install a pack or profile (by name or path), +To view all examples available to copy, type .. code-block:: bash - cmi install + cmi info examples -List and get installed examples, +To copy an example or list of examples to cwd, type .. code-block:: bash - cmi example list - cmi example (copy) + 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. From c5be515e1f4f2b691f69f99f875d2b89d3b62000 Mon Sep 17 00:00:00 2001 From: Caden Myers Date: Fri, 19 Dec 2025 15:17:49 -0600 Subject: [PATCH 2/4] news --- news/fix-readme-cli.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 news/fix-readme-cli.rst 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:** + +* From 9f1c2d974abc692e792514cd3661f35b87e68bf3 Mon Sep 17 00:00:00 2001 From: Caden Myers Date: Fri, 19 Dec 2025 15:19:45 -0600 Subject: [PATCH 3/4] minor readme fix --- README.rst | 6 ------ 1 file changed, 6 deletions(-) diff --git a/README.rst b/README.rst index 28d32a5..51c60e0 100644 --- a/README.rst +++ b/README.rst @@ -136,12 +136,6 @@ To install packs or profiles into your environment, type cmi install -To view all examples available to copy, type - -.. code-block:: bash - - cmi info examples - To copy an example or list of examples to cwd, type .. code-block:: bash From a46ddfdcce23e5a0bcb5b3c354b94017fc0f05ab Mon Sep 17 00:00:00 2001 From: Caden Myers Date: Fri, 19 Dec 2025 15:21:27 -0600 Subject: [PATCH 4/4] move doc link to top --- README.rst | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 51c60e0..e7ee53b 100644 --- a/README.rst +++ b/README.rst @@ -90,7 +90,8 @@ 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. @@ -163,9 +164,6 @@ To show basic information about your current conda environment, type cmi env -You may consult our `online documentation `_ for more information, -tutorials, and API references. - Support and Contribute ----------------------