49 lines (34 loc) · 810 Bytes

Quickstart

Install

uv sync --extra dev
uv pip install -e .

Launch the interactive UI

essentials

Run a single prompt

essentials -p "summarize this repository"

Preview runtime configuration

essentials --dry-run -p "inspect available tools"

Configure authentication

Use one of the built-in auth flows:

essentials auth login

Or set provider credentials directly:

export ANTHROPIC_API_KEY=...
export OPENAI_API_KEY=...

Common workflow

Start in the repository that should be analyzed or edited.
Launch essentials.
Ask for research, code changes, or verification.
Use --dry-run when validating settings or tool availability.
Use session persistence to resume work in the same project later.