Install
aster on your
PATH. Inspect the script first if you prefer
to read what runs.
From source instead, with Rust 1.85+:
aster upgrade, or pin a version with
aster upgrade --version 0.4.0 --force.
Sign in
Runaster init in any directory. The wizard walks through:
- Provider and model. Pick from the catalog, sign in through the browser,
or paste an API key. Keys are written to
~/.aster/.env, never to yaml. - Scope. Global (
~/.aster) by default, or--localto keep the config in the repository. - Web keys, optional. Search and page extraction work without a key; crawl and screenshots need one.
aster init --yes --force skips the questions and writes defaults. aster status shows what the next turn will use.
Provider sign-in is also available on its own:
aster login codex runs on a ChatGPT subscription against
https://chatgpt.com/backend-api/codex. Aster translates OpenAI’s Responses API
in both directions, so models and tools behave as they do anywhere else.
First turn
In a repository:edit mode, edits land in your working tree and commands run in
a sandbox. Press esc to interrupt a turn, shift+tab to change the permission
mode, and esc esc to quit.
Everyday flow
What to read next
- Chat: keys, slash commands, and one-shot mode.
- Permissions: the five modes and the rule language.
- Configuration: every
aster.yamlkey.