OnboardAI
Quick Start:
To generate a README for your project, open the Command Palette (Cmd+Shift+P or Ctrl+Shift+P), type Auto Generate README, and follow the prompts.
Tip: For free, high-quality README generation, select proxy as your LLM provider when prompted. If you choose another provider, you'll need to enter your own LLM API key.
Note: If you skip provider selection, the extension will generate a basic README using offline summarization (no LLM). For the best results, select proxy (free, high-quality) or another provider (with your own API key).
Prerequisite:
Overview
OnboardAI is a Visual Studio Code extension that automatically generates a detailed, well-documented README.md for any codebase.
Features
- Automatic README Generation: Scans your codebase and generates a comprehensive README file.
- VS Code Integration: Simple command to trigger README generation from within your editor.
- Supports Multiple LLM Providers: The extension prompts for your preferred LLM provider and API key, which are passed to the CLI (OpenAI, Anthropic, Gemini, etc. as supported by onboardai).
- Customizable Output: Generated README can be edited and extended as needed.
How It Works
- You are prompted to select your LLM provider and enter an API key if required.
- The CLI generates a detailed README, which is saved in a
.onboard-ai/README.md file in your project.
Setup Instructions
- Open your project folder in VS Code.
- Open the Command Palette (
Cmd+Shift+P or Ctrl+Shift+P).
- Type and select
Auto Generate README.
- Follow the prompts to select your LLM provider and enter your API key if needed.
- The extension will generate a new README in
.onboard-ai/README.md.
Extension Settings
This extension does not currently expose user-configurable settings. Future versions may allow customization of prompts, output location, and model selection.
Troubleshooting
- API key issues: Make sure you provide a valid API key for your selected provider when prompted.
- Permission issues: The extension writes to
.onboard-ai/README.md. Ensure you have write permissions in your project directory.
References
Enjoy automatic, high-quality documentation for your projects!
