Skip to content

Commit

Permalink
docs: improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
goszczynskip committed Nov 20, 2024
1 parent fc25942 commit 936d97d
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,13 @@ npx @tonik/arch-gen [options]
### Options

- `--ai [openai-api-key]`: Use this option to generate descriptions and tech stack information with the OpenAI API. If not provided, it will read from the `OPENAI_API_KEY` environment variable.

**Disclaimer**: When using the AI option, certain data is sent to the OpenAI API for processing. No code files are transmitted. The data includes:
- Directory names
- Monorepo file layout with external and internal package names
- Contents of `package.json`
- Contents of README files

- `-r, --root <path>`: Specify the root path of the monorepo.
- `-y, --yes`: Skip prompts and generate diagrams with default options.
- `-h, --help`: Display help information.
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "Architecture generator CLI tool",
"main": "dist/index.js",
"type": "module",
"git": "https://github.com/tonik/arch-gen",
"bin": {
"arch-gen": "./dist/index.js"
},
Expand Down

0 comments on commit 936d97d

Please sign in to comment.