Skip to content

Commit f56f55c

Browse files
committed
docs(readme): add CLI aliases and usage examples
1 parent 70d5a8e commit f56f55c

1 file changed

Lines changed: 29 additions & 2 deletions

File tree

README.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ ExplainThisRepo analyzes real project signals; configs, entrypoints, manifests,
2020
- Derives architectural summaries from repository structure and code signals.
2121
Not blind AI summarization.
2222
- Translates complex code structures into plain English
23+
- Speeds up understanding of unfamiliar codebases
2324
- Extract architecture signals from configs, entrypoints, and manifests
2425
- Works with GitHub repositories, local directories, private repositories, and monorepos
2526
- Outputs the explanation to an `EXPLAIN.md` file in your current directory or prints it directly in the terminal
@@ -46,6 +47,14 @@ pipx install explainthisrepo
4647
explainthisrepo owner/repo
4748
```
4849

50+
After installation, use any of the available commands:
51+
52+
```bash
53+
explainthisrepo owner/repo
54+
explain-this-repo owner/repo
55+
etr owner/repo
56+
```
57+
4958
To install support for specific models:
5059

5160
```bash
@@ -55,6 +64,8 @@ pip install explainthisrepo[anthropic]
5564
pip install explainthisrepo[groq]
5665
```
5766

67+
Replace `owner/repo` with the GitHub repository identifier (e.g., `facebook/react`, `torvalds/linux`).
68+
5869
### Option 2: Install with npm
5970

6071
Install globally and use forever:
@@ -71,9 +82,9 @@ Or without install:
7182

7283
```bash
7384
npx explainthisrepo owner/repo
74-
```
7585

76-
Replace `owner/repo` with the GitHub repository identifier (e.g., `facebook/react`).
86+
# npx explainthisrepo .
87+
```
7788

7889
### Option 3: Download standalone binary
7990

@@ -177,6 +188,22 @@ explainthisrepo ./path/to/directory
177188

178189
All inputs are normalized internally to `owner/repo`.
179190

191+
## CLI aliases
192+
193+
ExplainThisRepo ships with multiple command names that all map to the same entrypoint:
194+
195+
- `explainthisrepo` → primary command
196+
- `explain-this-repo` → readable alias
197+
- `etr` → short alias for faster typing
198+
199+
All three commands run the same tool and support the same flags and modes.
200+
201+
```bash
202+
explainthisrepo owner/repo
203+
explain-this-repo owner/repo
204+
etr owner/repo
205+
```
206+
180207
## Model selection
181208

182209
The `--llm` flag selects which configured model backend to use for the current command.

0 commit comments

Comments
 (0)