-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2d1a4ae
commit 4fd27ae
Showing
1 changed file
with
15 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,23 @@ | ||
# Arch gen | ||
# Arch Gen | ||
|
||
Tool to generate ARCHITECTURE file with mono repo diagrams with single command | ||
Arch Gen is a tool designed to generate an ARCHITECTURE file with monorepo diagrams using a single command. It leverages `mermaid` for diagram generation and can optionally use the `OpenAI API` for descriptions. | ||
|
||
## Requirements | ||
|
||
- pnpm | ||
- monorepo | ||
- **pnpm**: A fast, disk space-efficient package manager | ||
- **Monorepo**: A repository that contains multiple projects | ||
|
||
## Usage | ||
## Basic Usage | ||
|
||
To use Arch Gen, run the following command: | ||
|
||
```bash | ||
npx @tonik/arch-gen | ||
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. | ||
- `-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. |