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.
product get¶
Get details for a specific product.
feature¶
Manage features.
feature list¶
List features in a product.
| 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.
feature create¶
Create a new feature.
| 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.
| 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.
| 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.
epic¶
View epics.
epic list¶
List epics in a product.
epic get¶
Get an epic by reference number.
release¶
View releases.
release list¶
List releases in a product.
| Flag | Description |
|---|---|
--product, -p |
Product key (required) |
--active |
Only show unreleased |
release get¶
Get a release by reference number.
initiative¶
View strategic initiatives.
initiative list¶
List initiatives.
initiative get¶
Get an initiative by reference number.
goal¶
View goals.
goal list¶
List goals.
goal get¶
Get a goal by reference number.
requirement¶
Manage feature requirements.
requirement list¶
List requirements for a feature.
requirement get¶
Get a requirement by ID.
requirement create¶
Create a requirement on a feature.
| Flag | Description |
|---|---|
--feature |
Feature reference (required) |
--name |
Requirement name (required) |
--description |
Description |
requirement update¶
Update a requirement.
requirement delete¶
Delete a requirement.
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.
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.
user¶
View users.
user list¶
List users in the account.
user get¶
Get a user by ID or email.
user me¶
Get the current authenticated user.
canvas¶
Create and export strategic canvases.
canvas list¶
List canvases in a product.
canvas get¶
Get a canvas by ID.
canvas create bmc¶
Create a Business Model Canvas.
canvas create leanux¶
Create a Lean UX Canvas.
canvas create opportunity¶
Create an Opportunity Canvas.
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.