Skip to content

Commit 76ce66f

Browse files
1012Charanmt798jx
authored andcommitted
docs: update CLI usage examples in README (The-DevOps-Daily#370)
1 parent 4cc2290 commit 76ce66f

File tree

1 file changed

+28
-16
lines changed

1 file changed

+28
-16
lines changed

cli/README.md

Lines changed: 28 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,33 +2,45 @@
22

33
Interactive CLI tool companion for the 101 Linux Commands eBook.
44

5-
## Installation
5+
## Usage
66

7-
From the CLI directory:
7+
To get started, install the dependencies and run the CLI:
88

99
```bash
1010
pip install -r requirements.txt
11-
pip install -e .
11+
python -m cli.cli --help
1212
```
1313

14-
## Usage
14+
You can also install the CLI as an editable package:
1515

1616
```bash
17-
# Using the installed command
17+
pip install -e .
1818
linux-cli --help
19-
l101 --help
20-
21-
# Or running directly
22-
python -m cli.cli --help
2319
```
2420

25-
## Commands
21+
### Examples
2622

27-
### Hello Command
28-
```bash
29-
linux-cli hello greet
30-
linux-cli hello greet "Linux User"
31-
```
23+
Here are some examples of how to use the CLI:
24+
25+
> Note: The `list`, `search`, and `show` commands are still under development.
26+
27+
* **List all commands:**
28+
29+
```bash
30+
linux-cli list
31+
```
32+
33+
* **Search for a command:**
34+
35+
```bash
36+
linux-cli search grep
37+
```
38+
39+
* **Show details for a command:**
40+
41+
```bash
42+
linux-cli show ls
43+
```
3244

3345
## Development
3446

@@ -66,4 +78,4 @@ The CLI has its own workflow that runs:
6678
- Type checking (MyPy)
6779
- Tests (pytest)
6880

69-
This workflow only triggers on changes to the `cli/` directory.
81+
This workflow only triggers on changes to the `cli/` directory.

0 commit comments

Comments
 (0)