https://github.com/tonik/arch-gen

https://github.com/tonik/arch-gen

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/tonik/arch-gen
• Owner: tonik
• Created: 2024-11-20T14:27:51.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2024-11-20T14:47:51.000Z (about 1 month ago)
• Last Synced: 2024-11-20T15:39:06.373Z (about 1 month ago)
• Language: JavaScript
• Size: 74.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Arch Gen

This is a small tool that generates an ARCHITECTURE file with mono repo diagrams using a single command. It produces `mermaid` diagrams and can optionally enhance descriptions using the `OpenAI API`.

## Requirements

- **pnpm**

- **Monorepo**: A repository that contains multiple projects

## Basic Usage

To use Arch Gen, run the following command:

```bash

npx @tonik/arch-gen [options]

```

### Options

- `--ai [openai-api-key]`: This option generates 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 `: Specify the root path of the monorepo.

- `-y, --yes`: Skip prompts and generate diagrams with default options.

- `-h, --help`: Display help information.