# Quickstart

This guide takes you from zero setup to a complete first coding session.

## 1) Prerequisites

- Node.js `>= 22.19.0`
- npm `>= 10`
- macOS, Linux, or Windows
- At least one provider API key

Check versions:

```bash
node -v
npm -v
```

## 2) Install Voxcode

```bash
npm i -g @voxcode-dev/voxcode
```

Verify installation:

```bash
vox --version
vox --help
```

## 3) Configure a Provider

Pick one provider and export its key.

### Anthropic

```bash
export ANTHROPIC_API_KEY="your-key"
```

### OpenAI

```bash
export OPENAI_API_KEY="your-key"
```

### Google Gemini

```bash
export GEMINI_API_KEY="your-key"
```

See more providers in [providers.md](providers.md).

## 4) Start Your First Session

```bash
vox
```

Use a practical first prompt:

```text
Scan this repository and propose a safe plan to improve test coverage by 10%.
```

Voxcode can then:

- inspect files
- propose edits
- run tests/commands
- report results with context

## 5) Resume a Session

Resume the latest session:

```bash
vox --continue
```

Or pick from interactive session history inside the TUI.

## 6) Run One-Shot Commands

```bash
vox -p "List risky TODO comments in this codebase"
```

Useful for scripting and quick checks.

## 7) Next Steps

- Read [usage.md](usage.md) for everyday workflows
- Configure defaults in [settings.md](settings.md)
- Learn session branching in [sessions.md](sessions.md)
- Add custom behavior via [extensions.md](extensions.md)
