Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 52 additions & 16 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://diffpy.github.io/diffpy.cmi>`_ 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 <subcommand> -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 <pack_name>
cmi profile show <profile_name>
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 <pack_name|profile_name|/absolute/path/to/profile>
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) <example_name>
cmi info packs
cmi info profiles
cmi info examples

To install packs or profiles into your environment, type

.. code-block:: bash

cmi install <pack-name>
cmi install <profile-name>


To copy an example or list of examples to cwd, type

.. code-block:: bash

cmi copy <example-name>
cmi copy <example-name1> <example-name2>

To copy all examples from a pack or list of packs to cwd, type

.. code-block:: bash

cmi copy <pack-name>
cmi copy <pack-name1> <pack-name2>

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 <https://diffpy.github.io/diffpy.cmi>`_ for more information,
tutorials, and API references.

Support and Contribute
----------------------
Expand Down
23 changes: 23 additions & 0 deletions news/fix-readme-cli.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
**Added:**

* <news item>

**Changed:**

* Update command-line interface instructions in the README.

**Deprecated:**

* <news item>

**Removed:**

* <news item>

**Fixed:**

* <news item>

**Security:**

* <news item>
Loading