Quickstart
1
Install
- Homebrew
- Arch Linux
- Manual
2
Authenticate
3
Ask
Common workflows
- Interactive
- One-shot
- Pipe data
- Investigate
- Query the graph
- Use with agents
Start a terminal chat with session history and markdown output:
Repository context
Add an.annie.yaml file to a repository when you want every question from that workspace to use the same Anyshift project, metadata, and runbooks:
.annie.yaml
.annie.yaml by walking up from your current directory. Repository settings apply only to that invocation and do not change your global default project.
Use project-scoped personal context when a value should follow you across repositories:
.annie.yaml.
Invocation flags take precedence over TUI session context, repository context, and personal project context:
annie context preview to check file status without printing file contents.
Structured output
Pass a local JSON Schema when a script or CI job needs a predictable object instead of prose:service-risk.schema.json
--schema requires --output json and supports JSON Schema Draft 7 and Draft 2020-12 with an object at the root. Remote schema references are rejected.
Conversation history
Resume a previous investigation with its transcript instead of starting over:annie conversation delete <id> requires confirmation and may be restricted to administrators.
Reference
Query options
Query options
Graph commands
Graph commands
All non-interactive graph commands support
--project <name|uuid> and --output text|json. Run annie graph <command> --help for command-specific flags.Discover the query language without authentication:Automation and exit codes
Automation and exit codes
JSON output uses the
annie.cli/v1 envelope. Natural-language answers are returned under .answer.content, while Graph results are returned under .data.Require a schema-validated answer with:Sessions and TUI
Sessions and TUI
Use
Tab for command completion, Page Up/Down to scroll, and Ctrl+C to cancel.Past investigations and reports
Past investigations and reports
Projects
Projects
--project <name|uuid>.Authentication and CI
Authentication and CI
For local use:For CI, create an access token in Settings → Access tokens, store it as a secret, and set:
ANNIE_PROJECT_ID is only required when the token can access multiple projects. Use personal tokens locally and shared tokens for team automation. Token authentication cannot perform administrative operations.Feedback
Feedback
/rate up, /rate down, or /rate hypothesis <n> up|down.Configuration and privacy
Configuration and privacy
~/.annie/config.yaml. Disable anonymous telemetry with:NO_COLOR.Create account
Start using Anyshift
Request a demo
See the CLI in action