Skip to content

getting-started.md

Latest commit

 

History

History
162 lines (112 loc) · 2.57 KB

getting-started.md

File metadata and controls

162 lines (112 loc) · 2.57 KB

Getting Started

← Back to README · Docs Index

Install

Recommended

curl -fsSL https://install.ottocode.io | sh

To pin a release explicitly:

OTTO_VERSION=v0.1.231 curl -fsSL https://install.ottocode.io | sh

If you do not need a pinned version, prefer the default installer invocation above.

Via Bun

bun install -g @ottocode/install

From source

git clone https://github.com/nitishxyz/otto.git
cd otto
bun install
bun run compile

Configure a provider

Interactive setup:

otto setup

Or set credentials directly:

export ANTHROPIC_API_KEY="sk-ant-..."
export OPENAI_API_KEY="sk-..."
export GOOGLE_GENERATIVE_AI_API_KEY="..."
export OPENROUTER_API_KEY="..."

You can inspect what otto sees with:

otto doctor
otto auth list

First commands

otto
otto --web
otto "explain this error"
otto "write tests for this module" --agent build
otto "plan the refactor" --agent plan
otto "research auth handling" --agent research

Behavior notes:

  • otto starts the local API server and launches the TUI
  • otto --web starts the API and browser UI together
  • one-shot prompts stream through the same local server runtime

Server mode

otto serve
otto serve --port 3000
otto serve --network
otto serve --no-open

When you run otto serve --port 3000:

  • API listens on http://localhost:3000
  • Web UI is served on http://localhost:3001

The API is versioned under /v1/*, and /openapi.json exposes the generated spec.

Config file locations

Global config:

~/.config/otto/config.json
~/.config/otto/agents.json
~/.config/otto/tools/
~/.config/otto/commands/

Secure auth storage:

  • macOS: ~/Library/Application Support/otto/auth.json
  • Linux: $XDG_STATE_HOME/otto/auth.json or ~/.local/state/otto/auth.json
  • Windows: %APPDATA%/otto/auth.json

Project config:

.otto/config.json
.otto/agents.json
.otto/agents/<name>.md
.otto/tools/<tool-name>/tool.js

Troubleshooting quick checks

otto not found

Make sure your install path is on PATH:

echo $PATH | tr ':' '\n' | grep local

Provider/auth problems

otto doctor
otto auth login
otto auth list

Server route check

curl http://localhost:3000/
curl http://localhost:3000/openapi.json
curl http://localhost:3000/v1/server/info

Need more help?