Skip to content

getting-started.md

Latest commit

 

History

History
110 lines (84 loc) · 3.32 KB

getting-started.md

File metadata and controls

110 lines (84 loc) · 3.32 KB
Raw

Getting Started

A 5-minute path from install to first agent turn.

Install

curl -fsSL https://raw.githubusercontent.com/genai-io/san/main/install.sh | bash

Re-run the same command to upgrade. To uninstall, append -s uninstall.

Alternatives:

# via Go toolchain
go install github.com/genai-io/san/cmd/san@latest

# from source
git clone https://github.com/genai-io/san.git
cd san && go build -o san ./cmd/san

The binary is a single ~12 MB Go executable; no Node, no runtime.

First Run

san

On first launch, San drops into the TUI. Type /models to connect a provider — you will be asked for an API key (or routed through Vertex AI for Anthropic). Supported providers and the env var each one reads:

Provider Variable
Anthropic ANTHROPIC_API_KEY (or Vertex AI)
OpenAI OPENAI_API_KEY
Google GOOGLE_API_KEY
Moonshot MOONSHOT_API_KEY
Alibaba DASHSCOPE_API_KEY
MiniMax MINIMAX_API_KEY
MiMo MIMO_API_KEY
Z.ai (GLM / GLM Coding Plan) BIGMODEL_API_KEY
DeepSeek DEEPSEEK_API_KEY
Ollama (local) OLLAMA_BASE_URL (default http://localhost:11434/v1)
SenseNova SENSENOVA_API_KEY
Agnes-AI AGNESAI_API_KEY

You can also set them in .env or ~/.san/providers.json.

First Turn

Type a prompt and press Enter:

> explain what this repo does

San reads your project, plans, and acts. Tool calls (file reads, edits, bash) trigger a permission prompt by default — press Y to approve once, A to approve-all for this session.

Cheat Sheet

Action Key / command
Approve pending tool call Y
Approve all pending of this kind A
Reject pending tool call N
Toggle permission mode Shift+Tab
Expand tool details Ctrl+O
Cancel in-flight turn Ctrl+C
Exit Ctrl+D or /exit
List all slash commands /help
Switch model /models
Switch persona /persona
Save / resume session san --continue, san --resume

One-Shot and Piped Modes

san "explain this function"          # one-shot, prints answer and exits
cat main.go | san "review"           # piped input
san --continue                       # resume the last session

Where Configuration Lives

Scope Path What it holds
User ~/.san/providers.json Provider connections, current model
User ~/.san/settings.json Permissions, hooks, env, persona, search provider
User ~/.san/skills/ ~/.san/agents/ ~/.san/commands/ ~/.san/plugins/ Your personal extensions
Project <project>/.san/settings.json Per-project overrides
Project <project>/.san/{skills,agents,commands}/ Project-scoped extensions
Project <project>/SAN.md or CLAUDE.md Auto-loaded into the system prompt

See reference/configuration.md for the full schema.

What to Read Next