Getting Started

Getting started with Code-y is simple. You can install it globally via npm and run it on any project.

Installation

Install the package globally using npm:

npm install -g code-y

Basic Usage

Navigate to your project directory and run the `generate` command. This will analyze your code, generate all documentation data, and start the web server.

# Navigate to your project
cd /path/to/your-project

# Generate documentation and start the server
npx code-y generate

By default, the documentation will be available at `http://localhost:3000`.

Generating AI Descriptions

To leverage local AI models for generating descriptions, use the `--generate-descriptions` flag. Make sure you have Ollama running.

npx code-y generate --generate-descriptions

Analyzing a Different Project

You can run Code-y from any directory and target a specific project using the `--cwd` flag.

npx code-y --cwd /path/to/another-project generate