Getting started

Install

Use the install script:

curl -fsSL https://raw.githubusercontent.com/raine/aven/main/scripts/install | bash

Or install with Homebrew:

brew install raine/aven/aven

Or install the prebuilt release binary with Nix:

nix profile install https://github.com/raine/aven/releases/latest/download/aven-nix.tar.gz

Terminal font

Some TUI icons require a Nerd Font. Install one and select it as the font in your terminal profile. Without it, some icons may appear as blanks or boxes.

Open Aven

aven

Tasks live in a local SQLite database.

The TUI is the human interface for aven. It opens to the queue, which highlights tasks that need attention.

Use Configuration later when you want a specific database path, sync server, workspace routes, or project path mappings. Use aven doctor when config or database routing is unclear.

Explore the demo

aven demo

Every demo run starts from the same sample data, and changes are discarded on exit.

First session

1. Press a to add a task.
2. Fill in the title. Add a description, project, status, or priority when useful, and attach a screenshot or diagram when visual context helps.
3. Press Enter on a task to open its detail view, including image previews in supported terminals.
4. Use s to change status, d to mark done, and u to undo a TUI change.
5. Press ? for help or : for the command palette.

Agent setup

Install the aven skill so coding agents can learn the task workflow on demand:

aven skill install

For repositories where agents should start with live task context, configure automatic priming so the agent session receives aven prime output at startup.

See Work with agents for automatic priming, Claude Code hook setup, chat integrations, example prompts, and handoff notes.

Phone apps

Aven for iPhone and Android carries the same queue to your phone. The apps pair with sync, so set up sync first, then add the phone as a device. See the mobile apps.

Next steps

• Read Concepts to learn the task model.
• Read Using the TUI for navigation, views, filters, and shortcuts.
• Read Organizing tasks to choose among projects, labels, epics, dependencies, and workspaces.
• Read Scheduling tasks to defer work or set deadlines.
• Read Recurring tasks to set up work that returns on a schedule.
• Read Work with agents for coding agents and chat integrations.
• Read Sync across devices and Back up and restore when using Aven on several devices.
• Read Configuration for workspace routes, project path mappings, sync defaults, or a specific database path.