create-voltagent

Files (1)

• SKILL.md

SKILL.md (first lines)

# Create VoltAgent Skill

Complete guide for creating new VoltAgent projects. Includes the CLI flow and a full manual setup.

Official documentation: https://voltagent.dev/docs/

---

## Start Here

When a user wants to create a VoltAgent project, ask:

"How would you like to create your VoltAgent project?"

1. Automatic Setup - run `npm create voltagent-app@latest` and handle prompts
2. Interactive Guide - walk through each step and confirm choices
3. Manual Installation - set up dependencies and a full working example

Based on their choice:
- Option 1: run the CLI, capture server and provider choices, and finish setup
- Option 2: gather server, provider, and API key, then run the CLI
- Option 3: follow the manual steps below

---

## Before You Start

- Node.js 20+ (>= 20.19.0 recommended)
- Git (optional, for auto git init)
- An API key for your model provider (not needed for Ollama)

---

## Fast Path

Create a new VoltAgent project with one command:

```bash
npm create voltagent-app@latest
```

Other package managers:

```bash
pnpm create voltagent-app@latest
yarn create voltagent-app@latest
bun create voltagent-app@latest
```

---

## CLI Flow

The create-voltagent-app command:
1. Asks for a project name (default: `my-voltagent-app`)
2. Prompts for a server framework (Hono or Elysia)
3. Prompts for an AI provider (OpenAI, Anthropic, Google, Groq, Mistral, Ollama)
4. Prompts for an API key when required
5. Installs dependencies and scaffolds the project
6. Writes `.env`, `README.md`, `tsconfig.json`, `tsdown.config.ts`, and Docker files
7. Initializes a git repo when available

---

## CLI Walkthrough

1. Run:
   ```bash
   npm create voltagent-app@latest
   ```

2. When prompted:
   - Choose a server (Hono recommended or Elysia)
   - Choose an AI provider
   - Enter your API key (skip if using Ollama)

3. Start the dev server:
   ```bash
   cd <your-project-directory>
   npm run dev
   ```

4. If you chose Ollama:
   ```bash
   ollama pull llama3.2
   ```

---

## CLI Flags and Examples

Create in a specific directory:

```bash
npm create voltagent-app@latest my-voltagent-app
```

Download an example from the VoltAgent repo:

```bash
npm create voltagent-app@latest -- --example with-workflow
```

pnpm / yarn / bun equivalents:

```bash
pnpm create voltagent-app@latest -- --example with-workflow
yarn create voltagent-app@latest -- --example with-workflow
bun create voltagent-app@latest -- --example with-workflow
```

Notes:
- Examples are pulled from https://github.com/voltagent/voltagent/tree/main/examples
- Some package managers require `--` before `--example`.
- After an example download, run `npm install` and `npm run dev`.

---

## Generated Layout

From VoltAgent/skills, MIT.

More from VoltAgent/skills