Getting started

This page is the shortest path to a useful local run. It stays practical on purpose; the repository README remains the main orientation for product scope and common commands, while source and generated contracts are authoritative for exhaustive route and configuration details.

Install (macOS/Linux)

curl -fsSL https://asterel-rs.github.io/asterel/install.sh | sh
asterel onboard --interactive

The installer uses GitHub release binaries when available, falls back to a source build otherwise, and installs to ~/.local/bin by default. If your shell cannot find asterel yet, run ~/.local/bin/asterel onboard --interactive or add ~/.local/bin to PATH.

First run

asterel agent
asterel agent --message "Summarize my open tasks"

agent is useful for confirming the local provider and config. Use the daemon when you want the real product shape.

Build from source

git clone https://github.com/asterel-rs/asterel.git
cd asterel
cargo build --release
cargo run -- onboard --interactive
cargo run -- agent

Source builds need Rust stable, protoc v29 or newer, Git, and a provider credential or local provider selected during onboarding. PostgreSQL is the recommended memory backend; Markdown and none are available for constrained local testing.

Run the full daemon

For Discord, gateway, scheduler, and heartbeat to run together:

asterel daemon --host 127.0.0.1 --port 3000

This is the mode the turn pipeline was built for. Discord text is the primary product surface; connect it through the daemon using the configuration written by onboarding and the channel settings described in the README. Once a Discord message is accepted as a companion turn, it uses the shared transport path and the same enrichment and verification contract used by other accepted companion turns.

Check the local runtime before connecting Discord:

asterel config validate
asterel doctor
asterel status

Then follow Run Discord for the primary channel setup.

Where to go next

• Connect the primary surface — Run Discord.
• Operate the daemon — Operating locally and Gateway.
• Review memory and governance — Memory review and Security and governance.
• Understand the design — Overview and Companion runtime.
• Fix setup issues — Troubleshooting.