Skip to content

CLI Commands

Complete reference for all aha CLI commands.

Global Flags

These flags work with all commands:

Flag Description
--output, -o Output format: table, json
--help, -h Show help

product

Manage products (workspaces).

product list

List all products in your account.

aha product list

product get

Get details for a specific product.

aha product get PRODUCT-KEY

feature

Manage features.

feature list

List features in a product.

aha feature list --product PRODUCT-KEY [flags]
Flag Description
--product, -p Product key (required)
--status Filter by status
--release Filter by release
--assigned-to Filter by assignee email
--limit Maximum results

feature get

Get a feature by reference number.

aha feature get FEAT-123

feature create

Create a new feature.

aha feature create --product PRODUCT-KEY --name "Feature Name" [flags]
Flag Description
--product, -p Product key (required)
--name Feature name (required)
--description Feature description
--release Release to assign
--status Initial status

feature update

Update an existing feature.

aha feature update FEAT-123 [flags]
Flag Description
--name New name
--description New description
--status New status
--release New release

idea

View customer ideas.

idea list

List ideas in a product.

aha idea list --product PRODUCT-KEY [flags]
Flag Description
--product, -p Product key (required)
--sort Sort by: votes, created_at, updated_at
--limit Maximum results

idea get

Get an idea by reference number.

aha idea get IDEA-456

epic

View epics.

epic list

List epics in a product.

aha epic list --product PRODUCT-KEY

epic get

Get an epic by reference number.

aha epic get EPIC-789

release

View releases.

release list

List releases in a product.

aha release list --product PRODUCT-KEY [flags]
Flag Description
--product, -p Product key (required)
--active Only show unreleased

release get

Get a release by reference number.

aha release get REL-2024Q1

initiative

View strategic initiatives.

initiative list

List initiatives.

aha initiative list --product PRODUCT-KEY

initiative get

Get an initiative by reference number.

aha initiative get INIT-123

goal

View goals.

goal list

List goals.

aha goal list --product PRODUCT-KEY

goal get

Get a goal by reference number.

aha goal get GOAL-456

requirement

Manage feature requirements.

requirement list

List requirements for a feature.

aha requirement list --feature FEAT-123

requirement get

Get a requirement by ID.

aha requirement get REQ-789

requirement create

Create a requirement on a feature.

aha requirement create --feature FEAT-123 --name "Requirement" [flags]
Flag Description
--feature Feature reference (required)
--name Requirement name (required)
--description Description

requirement update

Update a requirement.

aha requirement update REQ-789 --name "Updated Name"

requirement delete

Delete a requirement.

aha requirement delete REQ-789

comment

Manage comments on entities.

comment list

List comments.

aha comment list --feature FEAT-123
aha comment list --idea IDEA-456
aha comment list --product PRODUCT-KEY

comment get

Get a comment by ID.

aha comment get COMMENT-ID

comment create

Add a comment.

aha comment create --feature FEAT-123 --body "Comment text"
aha comment create --idea IDEA-456 --body "Comment text"

comment delete

Delete a comment.

aha comment delete COMMENT-ID

user

View users.

user list

List users in the account.

aha user list

user get

Get a user by ID or email.

aha user get USER-ID
aha user get user@company.com

user me

Get the current authenticated user.

aha user me

canvas

Create and export strategic canvases.

canvas list

List canvases in a product.

aha canvas list --product PRODUCT-KEY

canvas get

Get a canvas by ID.

aha canvas get CANVAS-ID

canvas create bmc

Create a Business Model Canvas.

aha canvas create bmc --product PRODUCT-KEY --name "My BMC" --file bmc.json

canvas create leanux

Create a Lean UX Canvas.

aha canvas create leanux --product PRODUCT-KEY --name "My Lean UX" --file leanux.json

canvas create opportunity

Create an Opportunity Canvas.

aha canvas create opportunity --product PRODUCT-KEY --name "Opportunity" --file opp.json

canvas export

Export a canvas to various formats.

aha canvas export CANVAS-ID --format png --output canvas.png
aha canvas export CANVAS-ID --format pdf --output canvas.pdf

completion

Generate shell completion scripts.

# Bash
aha completion bash

# Zsh
aha completion zsh

# Fish
aha completion fish

# PowerShell
aha completion powershell