Skip to content

Commit 7e0c86d

Browse files
authored
Merge pull request #100 from cadenmyers13/fix-readme-cli
doc: Fix `README.rst` cli section
2 parents de1dbb0 + a46ddfd commit 7e0c86d

File tree

2 files changed

+75
-16
lines changed

2 files changed

+75
-16
lines changed

README.rst

Lines changed: 52 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -90,43 +90,79 @@ Getting Started
9090

9191
Use the `cmi` command-line interface to install and manage modular optional dependencies, known as `packs`,
9292
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:
93+
known as `profiles`. You may consult our `online documentation <https://diffpy.github.io/diffpy.cmi>`_ for more information,
94+
tutorials, and API references.
95+
96+
The ``-h`` flag is available for **all** cmi commands and subcommands.
97+
It's highly recommended to use it wherever necessary.
9498

95-
Show available commands and options,
99+
To display help for the main CLI, type
96100

97101
.. code-block:: bash
98102
99-
cmi -h
103+
cmi -h
104+
cmi --help
100105
101-
List installed and available packs and profiles,
106+
Display help for a specific subcommand with,
102107

103108
.. code-block:: bash
104109
105-
cmi pack list
106-
cmi profile list
110+
cmi <subcommand> -h
107111
108-
Show details of a specific pack or profile,
112+
Open the full online manual in a web browser by typing,
109113

110114
.. code-block:: bash
111115
112-
cmi pack show <pack_name>
113-
cmi profile show <profile_name>
116+
cmi --manual
114117
115-
Install a pack or profile (by name or path),
118+
To print information about available and installed packs, profiles, and examples, type,
116119

117120
.. code-block:: bash
118121
119-
cmi install <pack_name|profile_name|/absolute/path/to/profile>
122+
cmi info
120123
121-
List and get installed examples,
124+
To print information about packs, profiles, or examples, type
122125

123126
.. code-block:: bash
124127
125-
cmi example list
126-
cmi example (copy) <example_name>
128+
cmi info packs
129+
cmi info profiles
130+
cmi info examples
131+
132+
To install packs or profiles into your environment, type
133+
134+
.. code-block:: bash
135+
136+
cmi install <pack-name>
137+
cmi install <profile-name>
138+
139+
140+
To copy an example or list of examples to cwd, type
141+
142+
.. code-block:: bash
143+
144+
cmi copy <example-name>
145+
cmi copy <example-name1> <example-name2>
146+
147+
To copy all examples from a pack or list of packs to cwd, type
148+
149+
.. code-block:: bash
150+
151+
cmi copy <pack-name>
152+
cmi copy <pack-name1> <pack-name2>
153+
154+
To copy all examples to cwd, type
155+
156+
.. code-block:: bash
157+
158+
cmi copy all
159+
160+
To show basic information about your current conda environment, type
161+
162+
.. code-block:: bash
163+
164+
cmi env
127165
128-
You may consult our `online documentation <https://diffpy.github.io/diffpy.cmi>`_ for more information,
129-
tutorials, and API references.
130166
131167
Support and Contribute
132168
----------------------

news/fix-readme-cli.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
**Added:**
2+
3+
* <news item>
4+
5+
**Changed:**
6+
7+
* Update command-line interface instructions in the README.
8+
9+
**Deprecated:**
10+
11+
* <news item>
12+
13+
**Removed:**
14+
15+
* <news item>
16+
17+
**Fixed:**
18+
19+
* <news item>
20+
21+
**Security:**
22+
23+
* <news item>

0 commit comments

Comments
 (0)