File tree Expand file tree Collapse file tree 1 file changed +34
-1
lines changed Expand file tree Collapse file tree 1 file changed +34
-1
lines changed Original file line number Diff line number Diff line change @@ -88,7 +88,40 @@ and run the following ::
8888Getting Started
8989---------------
9090
91- You may consult our `online documentation <https://diffpy.github.io/diffpy.cmi >`_ for tutorials and API references.
91+ Use the `cmi ` command-line interface to install and manage modular optional dependencies, known as `packs `,
92+ and to configure or execute user-defined workflows that combine multiple packs with optional post-installation steps,
93+ known as `profiles `. To use `cmi `, you can run the following example commands:
94+
95+ .. code-block :: bash
96+ :caption: Show available commands and options
97+
98+ cmi -h
99+
100+ .. code-block :: bash
101+ :caption: List installed and available packs and profiles
102+
103+ cmi pack list
104+ cmi profile list
105+
106+ .. code-block :: bash
107+ :caption: Show details of a specific pack or profile
108+
109+ cmi pack show < pack_name>
110+ cmi profile show < profile_name>
111+
112+ .. code-block :: bash
113+ :caption: Install a pack or profile (by name or path)
114+
115+ cmi install < pack_name| profile_name| /absolute/path/to/profile>
116+
117+ .. code-block :: bash
118+ :caption: List and get installed examples
119+
120+ cmi example list
121+ cmi example (copy) < example_name>
122+
123+ You may consult our `online documentation <https://diffpy.github.io/diffpy.cmi >`_ for more information,
124+ tutorials, and API references.
92125
93126Support and Contribute
94127----------------------
You can’t perform that action at this time.
0 commit comments