Quick Start
This guide gets you from zero to a running Open Astra gateway in under 60 seconds using npx astra.
ℹYou need Node.js 20+ and Docker Desktop running. No global install is required.
Step 1 — Run npx astra
bash
npx astraOn the first run, the setup wizard launches automatically. It takes about 30 seconds to complete.
Step 2 — Complete the wizard
The wizard asks four questions:
- Which LLM provider do you want to use? — Select one or more from the list (OpenAI, Anthropic, Groq, Gemini, Grok, Mistral, OpenRouter, Ollama, vLLM, Bedrock)
- Enter your API key — Paste the key for your selected provider
- What port should the gateway use? — Default is
3000; press Enter to accept - Generate JWT secret? — Press Enter to auto-generate a secure secret
After the wizard finishes, your config is saved to ~/.astra/config.json and the gateway starts automatically.
What happens on first run
After the wizard completes, Open Astra starts several services in sequence:
- Pulls and starts
astra-postgresandastra-typesenseDocker containers - Waits for both services to be healthy (usually 5–10 seconds)
- Runs all 140 database migrations automatically
- Loads
astra.ymlif present, or uses built-in defaults - Registers 109 skills and 67 tools
- Starts the Express gateway on the configured port
You will see output like:
bash
[astra] Starting containers...
[astra] postgres ✓ healthy
[astra] typesense ✓ healthy
[astra] Running 140 migrations... done
[astra] Loaded 3 agents from astra.yml
[astra] Registered 109 skills, 67 tools
[astra] Gateway listening on http://localhost:3000Step 3 — Verify the gateway works
Open a new terminal and send a test request:
bash
# Health check
curl http://localhost:3000/health
# Expected response:
# { "status": "ok", "version": "...", "uptime": 12 }Or use the interactive CLI to chat with an agent immediately:
bash
npx astra chat
# You should see:
# Connected to http://localhost:3000
# Agent: default-agent (gpt-4o)
# Type a message and press Enter. /help for commands.
#
# > Hello! What can you do?Next steps
- Configure astra.yml — define your agent team with custom models, skills, and spawn rules
- Create agents — add specialist agents for coding, research, or domain-specific tasks
- Connect a channel — connect Telegram, Slack, or Discord so your team can talk to agents from anywhere
- Explore memory — understand how the 5-tier memory system keeps agents smart across sessions
💡Run
npx astra doctor at any time to check that all services are healthy and all required configuration is present.