|
2 | 2 |
|
3 | 3 | > An AI-powered CLI tool that automatically generates clear, natural-language descriptions for every file within a given repository. `repo-description` helps developers quickly understand unfamiliar codebases, onboard new team members, and maintain comprehensive documentation effortlessly. By leveraging advanced AI, it transforms raw code into insightful summaries, making project navigation and collaboration significantly smoother. |
4 | 4 |
|
| 5 | +<!-- doc-gen BADGES --> |
| 6 | + |
| 7 | +[](https://www.npmjs.com/package/repo-description) [](https://www.npmjs.com/package/repo-description) [](https://www.npmjs.com/package/repo-description) [](https://github.com/IonGireada/repo-description/actions) [](https://codecov.io/gh/IonGireada/repo-description) [](https://github.com/IonGireada/repo-description/releases) [](https://github.com/IonGireada/repo-description/graphs/commit-activity) [](https://github.com/IonGireada/repo-description/stargazers) [](https://github.com/IonGireada/repo-description/network/members) [](https://github.com/IonGireada/repo-description/watchers) [](https://github.com/IonGireada/repo-description/commits) [](https://github.com/IonGireada/repo-description/graphs/contributors) [](https://github.com/IonGireada/repo-description/issues) [](https://github.com/IonGireada/repo-description/pulls) [](https://github.com/IonGireada/repo-description) [](https://github.com/IonGireada/repo-description) [](https://github.com/IonGireada/repo-description/search?l=) |
| 8 | + |
| 9 | +<!-- end-doc-gen --> |
| 10 | + |
5 | 11 | ## Features |
6 | 12 |
|
7 | 13 | - **AI-Powered Descriptions**: Generates concise, natural-language summaries for individual files using advanced AI models. |
|
11 | 17 | - **Markdown-Magic Integration**: Seamlessly updates `markdown-magic.config.js` files to embed descriptions directly into your documentation. |
12 | 18 | - **CLI & Module Usage**: Can be used as a standalone command-line tool or integrated as a JavaScript module within other projects. |
13 | 19 |
|
14 | | -<!-- doc-gen BADGES --> |
15 | | - |
16 | | -[](https://www.npmjs.com/package/repo-description) [](https://www.npmjs.com/package/repo-description) [](https://www.npmjs.com/package/repo-description) [](https://github.com/IonGireada/repo-description/actions) [](https://codecov.io/gh/IonGireada/repo-description) [](https://github.com/IonGireada/repo-description/releases) [](https://github.com/IonGireada/repo-description/graphs/commit-activity) [](https://github.com/IonGireada/repo-description/stargazers) [](https://github.com/IonGireada/repo-description/network/members) [](https://github.com/IonGireada/repo-description/watchers) [](https://github.com/IonGireada/repo-description/commits) [](https://github.com/IonGireada/repo-description/graphs/contributors) [](https://github.com/IonGireada/repo-description/issues) [](https://github.com/IonGireada/repo-description/pulls) [](https://github.com/IonGireada/repo-description) [](https://github.com/IonGireada/repo-description) [](https://github.com/IonGireada/repo-description/search?l=) |
17 | | - |
18 | | -<!-- end-doc-gen --> |
19 | | - |
20 | 20 | ## Getting Started |
21 | 21 |
|
22 | 22 | **Important:** Before running, create a `.env` file in your project root with your Groq API key. The key must be named `GROQ_API_KEY`. You can obtain an API key by creating an account and visiting [https://console.groq.com/keys](https://console.groq.com/keys). |
@@ -179,43 +179,43 @@ Options: |
179 | 179 |
|
180 | 180 | <!-- doc-gen COMMANDS format=list --> |
181 | 181 |
|
182 | | -- `describe` — Generates AI-powered descriptions for repository files and outputs them in various formats. (line [86](./package.json#L86)) |
| 182 | +- `describe` — Generates AI-powered descriptions for repository files and outputs them in various formats. (line [85](./package.json#L85)) |
183 | 183 |
|
184 | 184 | ```bash |
185 | 185 | node src/cli.js . descriptions.json && node src/cli.js . descriptions.md --format markdown && node src/cli.js . descriptions-table.md --format markdown --table && node src/cli.js . descriptions-summary.md --format markdown --summary && node src/cli.js . descriptions-table-summary.md --format markdown --table --summary |
186 | 186 | ``` |
187 | 187 |
|
188 | | -- `docs` — Generates documentation by processing Markdown files with markdown-magic. (line [91](./package.json#L91)) |
| 188 | +- `docs` — Generates documentation by processing Markdown files with markdown-magic. (line [90](./package.json#L90)) |
189 | 189 |
|
190 | 190 | ```bash |
191 | 191 | npx [email protected] **/ *.md -c md.config.js |
192 | 192 | ``` |
193 | 193 |
|
194 | | -- `format` — Formats the codebase using Prettier. (line [89](./package.json#L89)) |
| 194 | +- `format` — Formats the codebase using Prettier. (line [88](./package.json#L88)) |
195 | 195 |
|
196 | 196 | ```bash |
197 | 197 | prettier --write . |
198 | 198 | ``` |
199 | 199 |
|
200 | | -- `lint` — Lints the codebase for potential errors and style violations. (line [87](./package.json#L87)) |
| 200 | +- `lint` — Lints the codebase for potential errors and style violations. (line [86](./package.json#L86)) |
201 | 201 |
|
202 | 202 | ```bash |
203 | 203 | eslint src/ **/*.js **/*.json |
204 | 204 | ``` |
205 | 205 |
|
206 | | -- `lint:fix` — Lints the codebase and automatically fixes fixable issues. (line [88](./package.json#L88)) |
| 206 | +- `lint:fix` — Lints the codebase and automatically fixes fixable issues. (line [87](./package.json#L87)) |
207 | 207 |
|
208 | 208 | ```bash |
209 | 209 | eslint --fix src/ **/*.js **/*.json |
210 | 210 | ``` |
211 | 211 |
|
212 | | -- `prep` — Prepares the codebase by generating documentation, linting, and formatting. (line [90](./package.json#L90)) |
| 212 | +- `prep` — Prepares the codebase by generating documentation, linting, and formatting. (line [89](./package.json#L89)) |
213 | 213 |
|
214 | 214 | ```bash |
215 | 215 | npm run docs && npm run lint:fix && npm run format |
216 | 216 | ``` |
217 | 217 |
|
218 | | -- `test` — Runs the test suite using Jest. (line [85](./package.json#L85)) |
| 218 | +- `test` — Runs the test suite using Jest. (line [84](./package.json#L84)) |
219 | 219 |
|
220 | 220 | ```bash |
221 | 221 | jest --passWithNoTests |
|
0 commit comments