Skip to content

README.md

Latest commit

 

History

History
94 lines (71 loc) · 3.04 KB

README.md

File metadata and controls

94 lines (71 loc) · 3.04 KB
Raw

Getting started with Astra

Choose the path that matches what you want to do. All paths use the same durable agent backbone; the difference is where Astra runs and which capacity providers are connected.

Goal Path
Evaluate Astra and use the CLI/TUI Docker quick start — no Rust or Node toolchain
Build Astra locally Build from source
Prepare a real deployment Production deployment
Change Astra itself Developer setup

Build from source

Prerequisites

  • Git and Make
  • Docker with Docker Compose
  • Rust via rustup (the repository pins the required toolchain)
  • Node.js 24 (pinned in .nvmrc)
  • OpenSSL command-line tools
  • At least one supported LLM endpoint, plus either an embedding API for semantic memory or deterministic mock embeddings for local evaluation

Initialize and start

git clone https://github.com/matrixorigin/Astra.git
cd Astra

cp .models.yaml.example .models.yaml
make dev-init

Configure MEMORIA_EMBEDDING_BASE_URL in .env for semantic memory and add MEMORIA_EMBEDDING_API_KEY when the endpoint requires authentication, or set MEMORIA_EMBEDDING_PROVIDER=mock for local evaluation. Then add credentials for at least one model endpoint to .models.yaml. Never commit either local file.

make build-cli-debug
make dev-start

export PATH="$PWD/target/debug:$PATH"
astra health

The default development endpoints are:

Create the first account and model offering

astra admin register
astra admin model load .models.yaml --update-existing
astra admin model check <model-name>

Start the TUI or send a one-shot request:

astra
astra chat -m "Map this repository and explain its architecture"

Server-only mode deliberately has no ambient access to host files, processes, or Git. Connect a User Runner when Web sessions need a local workspace:

ASTRA_EDGE_WORKSPACE_DIR=/path/to/workspace make dev-edge-start

On later starts, make dev-start-server-edge brings up the Server and local User Runner together. make dev-start always returns to the deterministic Server-only boundary.

Next steps

Task Documentation
Learn the CLI and TUI CLI commands · slash commands
Integrate an application TypeScript SDK · HTTP API
Understand settings Configuration reference
Deploy Astra Deployment overview
Develop Astra Development workflow · testing guide
Diagnose a problem Troubleshooting

Return to the documentation index for the complete user, operator, contributor, and kernel-design map.