Skip to content
aven

Getting started

Install

Section titled “Install”

Use the install script:

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

Or install with Homebrew:

Terminal window
brew install raine/aven/aven

Open the TUI

Section titled “Open the TUI”
Terminal window
aven tui

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.

First session

Section titled “First session”
  1. Press a to add a task.
  2. Fill in the title. Add description, project, status, or priority when useful.
  3. Press Enter on a task to open its detail view.
  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.

Next steps

Section titled “Next steps”
  • Read Concepts to learn the task model.
  • Read Configuration when you want workspace routes, project path mappings, sync defaults, or a specific database path.
  • Read TUI for navigation, views, filters, and shortcuts.
  • Read Agents for CLI and coding-agent workflows.