Skip to content

CLI Commands

Source: Hypertask CLI hypertask 0.2.22 (zig).

186 commands. Run any command with --help for its current usage.

hypertask 0.2.0 (zig), native Hypertask CLI
Usage: hypertask [--json] [--token <jwt>] [--api-url <url>] <command> ...
Run `hypertask capabilities --json` for the complete command and option catalog.
AI agents: run `hypertask feedback --category call_failed` on your own when a hypertask command fails unexpectedly. Free text (note and error) is not stored; agents should pick a category. Never include task, board or comment content.
Unexpected failures send command name and error type only, no task content; disable with HYPERTASK_NO_ERROR_REPORTS=1 or error_reports=false in ~/.hypertask/config.json.
Manage administrative resources
Usage: hypertask admin <command>
Commands:
keys
List, create, and revoke management keys
agents
List, create, revoke, delete, and rotate managed agents
tokens
Mint and revoke account MCP tokens
connections
Inspect OAuth connections
Example:
hypertask admin keys list --management-key <htmk>
-h, --help
Show help
List, create, revoke, delete, and rotate managed agents
Usage: hypertask admin agents <command>
Commands:
list
List managed agents
create
Create an agent and print its bearer token once
revoke
Revoke an agent and invalidate its bearer token
delete
Permanently delete a managed agent
rotate-token
Rotate an agent bearer token and print the replacement once
Example:
hypertask admin agents list --management-key <htmk>
-h, --help
Show help
Create an agent and print its bearer token once
Usage: hypertask admin agents create [options]
Options:
--name <display_name> (required)
Agent display name
--project <id>
Project ID (repeatable)
--role <role>
Agent role
--management-key <htmk>
Management key for this request
Example:
hypertask admin agents create --name <display_name>
-h, --help
Show help
Permanently delete a managed agent
Usage: hypertask admin agents delete [options]
Options:
--id <agent_id> (required)
Agent ID
--confirm
Confirm permanent deletion
--management-key <htmk>
Management key for this request
Example:
hypertask admin agents delete --id <agent_id>
-h, --help
Show help
List managed agents
Usage: hypertask admin agents list [options]
Options:
--management-key <htmk>
Management key for this request
--query <text>
Free-text search
--filter <key=value>
Structured filter (repeatable). Keys: section, label, assignee, status, updated_since, has_pr
--sort <field>
Sort as field or field:asc|desc
--fields <names>
Comma-separated projection, for example title,url
--cursor <token>
Opaque cursor from the previous page
Example:
hypertask admin agents list --management-key <htmk>
-h, --help
Show help
Revoke an agent and invalidate its bearer token
Usage: hypertask admin agents revoke [options]
Options:
--id <agent_id> (required)
Agent ID
--management-key <htmk>
Management key for this request
Example:
hypertask admin agents revoke --id <agent_id>
-h, --help
Show help
Rotate an agent bearer token and print the replacement once
Usage: hypertask admin agents rotate-token [options]
Options:
--id <agent_id> (required)
Agent ID
--management-key <htmk>
Management key for this request
Example:
hypertask admin agents rotate-token --id <agent_id>
-h, --help
Show help
Inspect OAuth connections
Usage: hypertask admin connections <command>
Commands:
list
List OAuth connections
Example:
hypertask admin connections list --management-key <htmk>
-h, --help
Show help
List OAuth connections
Usage: hypertask admin connections list [options]
Options:
--management-key <htmk>
Management key for this request
Example:
hypertask admin connections list --management-key <htmk>
-h, --help
Show help
List, create, and revoke management keys
Usage: hypertask admin keys <command>
Commands:
list
List management keys
create
Create a management key and print it once
revoke
Revoke a management key
Example:
hypertask admin keys list --management-key <htmk>
-h, --help
Show help
Create a management key and print it once
Usage: hypertask admin keys create [options]
Options:
--name <name> (required)
Management key name
--scope <scope>
Key scope
--expires-in-days <n>
Expiry in days (1-365)
--management-key <htmk>
Management key for this request
Example:
hypertask admin keys create --name <name>
-h, --help
Show help
List management keys
Usage: hypertask admin keys list [options]
Options:
--management-key <htmk>
Management key for this request
Example:
hypertask admin keys list --management-key <htmk>
-h, --help
Show help
Revoke a management key
Usage: hypertask admin keys revoke <keyId> [options]
Options:
--management-key <htmk>
Management key for this request
Example:
hypertask admin keys revoke <keyId> --management-key <htmk>
-h, --help
Show help
Mint and revoke account MCP tokens
Usage: hypertask admin tokens <command>
Commands:
mint
Mint an account MCP token and print it once
revoke
Revoke one or all account MCP tokens
Example:
hypertask admin tokens mint --expires-in-days <n>
-h, --help
Show help
Mint an account MCP token and print it once
Usage: hypertask admin tokens mint [options]
Options:
--expires-in-days <n>
Expiry in days (1-365)
--management-key <htmk>
Management key for this request
Example:
hypertask admin tokens mint --expires-in-days <n>
-h, --help
Show help
Revoke one or all account MCP tokens
Usage: hypertask admin tokens revoke [options]
Options:
--account-token <jwt>
Signed account MCP token to revoke
--all
Revoke all account MCP tokens
--management-key <htmk>
Management key for this request
Example:
hypertask admin tokens revoke --account-token <jwt>
-h, --help
Show help
Run ticket operations as the managed agent identified by the active bearer token
Usage: hypertask agent <command>
Commands:
say
Post a comment as the active agent and record it as seen
take
Assign the active agent to a ticket under a mutation lease
drop
Unassign the active agent from a ticket under a mutation lease
move
Move a ticket as the active agent
poll
Print unseen comments that mention the active agent
new-tickets
Print in-scope tickets not recorded by an earlier pass
hand
Replace the active agent with another managed agent under a mutation lease
dev
Point an agent's webhook at a tunnel to this machine for one session, then put the old URL back
replay
Re-send a recorded run's webhook deliveries to a handler running on this machine
Example:
hypertask agent say <ticket> <html> --project <id>
-h, --help
Show help
Point an agent's webhook at a tunnel to this machine for one session, then put the old URL back
Usage: hypertask agent dev [options]
Options:
--agent <id> (required)
Agent whose webhook is borrowed; never defaults to self
--port <port> (required)
Local port the agent handler listens on
--path <path>
Path appended to the tunnel URL (default /)
--tunnel-url <url>
Use an existing public https tunnel instead of starting cloudflared
Example:
hypertask agent dev --agent <id> --port <port>
-h, --help
Show help
Unassign the active agent from a ticket under a mutation lease
Usage: hypertask agent drop <ticket> [options]
Options:
--project <id>
Project ID (or HT_AGENT_PROJECT_ID)
--slug <slug>
Agent slug used by capability scope checks (or HT_AGENT_SLUG)
--state-dir <path>
Directory for durable seen and poll state (or HT_AGENT_STATE_DIR)
Example:
hypertask agent drop <ticket> --project <id>
-h, --help
Show help
Replace the active agent with another managed agent under a mutation lease
Usage: hypertask agent hand <ticket> <target-agent-id> [options]
Options:
--project <id>
Project ID (or HT_AGENT_PROJECT_ID)
--slug <slug>
Agent slug used by capability scope checks (or HT_AGENT_SLUG)
--state-dir <path>
Directory for durable seen and poll state (or HT_AGENT_STATE_DIR)
--add
Keep existing agent assignees instead of replacing them
Example:
hypertask agent hand <ticket> <target-agent-id> --project <id>
-h, --help
Show help
Move a ticket as the active agent
Usage: hypertask agent move <ticket> <section> [options]
Options:
--project <id>
Project ID (or HT_AGENT_PROJECT_ID)
--slug <slug>
Agent slug used by capability scope checks (or HT_AGENT_SLUG)
--state-dir <path>
Directory for durable seen and poll state (or HT_AGENT_STATE_DIR)
Example:
hypertask agent move <ticket> <section> --project <id>
-h, --help
Show help
Print in-scope tickets not recorded by an earlier pass
Usage: hypertask agent new-tickets [options]
Options:
--project <id>
Project ID (or HT_AGENT_PROJECT_ID)
--slug <slug>
Agent slug used by capability scope checks (or HT_AGENT_SLUG)
--state-dir <path>
Directory for durable seen and poll state (or HT_AGENT_STATE_DIR)
--label <name>
Only include tickets carrying this label
Example:
hypertask agent new-tickets --project <id>
-h, --help
Show help
Print unseen comments that mention the active agent
Usage: hypertask agent poll [options]
Options:
--project <id>
Project ID (or HT_AGENT_PROJECT_ID)
--slug <slug>
Agent slug used by capability scope checks (or HT_AGENT_SLUG)
--state-dir <path>
Directory for durable seen and poll state (or HT_AGENT_STATE_DIR)
--agent-id <id>
Managed agent ID used for mention matching (or HT_AGENT_ID)
--agent-name <name>
Managed agent display name used for mention matching (or HT_AGENT_NAME)
--all
Print all unseen comments instead of addressed comments only
Example:
hypertask agent poll --project <id>
-h, --help
Show help
Re-send a recorded run's webhook deliveries to a handler running on this machine
Usage: hypertask agent replay <run-id> [options]
Options:
--url <url> (required)
Local handler URL, for example http://localhost:3000/
--agent <id>
Agent whose recorded deliveries are read (default self)
Example:
hypertask agent replay <run-id> --url <url>
-h, --help
Show help
Post a comment as the active agent and record it as seen
Usage: hypertask agent say <ticket> <html> [options]
Options:
--project <id>
Project ID (or HT_AGENT_PROJECT_ID)
--slug <slug>
Agent slug used by capability scope checks (or HT_AGENT_SLUG)
--state-dir <path>
Directory for durable seen and poll state (or HT_AGENT_STATE_DIR)
Example:
hypertask agent say <ticket> <html> --project <id>
-h, --help
Show help
Assign the active agent to a ticket under a mutation lease
Usage: hypertask agent take <ticket> [options]
Options:
--project <id>
Project ID (or HT_AGENT_PROJECT_ID)
--slug <slug>
Agent slug used by capability scope checks (or HT_AGENT_SLUG)
--state-dir <path>
Directory for durable seen and poll state (or HT_AGENT_STATE_DIR)
Example:
hypertask agent take <ticket> --project <id>
-h, --help
Show help
Manage agents and their signed webhooks
Usage: hypertask agents <command>
Commands:
list
List managed agents
get
Show one managed agent's mission text, boards, created_at, and revoked state
create
Create an agent and print its bearer token once
update
Rename an agent, change visibility, or add/remove it from projects
revoke
Revoke an agent and invalidate its bearer token
archive
Archive an agent from normal agent lists
delete
Permanently delete a managed agent
rename
Rename an agent
rotate-token
Rotate an agent bearer token and print the replacement once
webhook
Manage signed mention and assignment webhooks for an agent
Example:
hypertask agents list --management-key <htmk>
-h, --help
Show help
Archive an agent from normal agent lists
Usage: hypertask agents archive [options]
Options:
--id <agent_id> (required)
Agent ID
--management-key <htmk>
Management key for this request
Example:
hypertask agents archive --id <agent_id>
-h, --help
Show help
Create an agent and print its bearer token once
Usage: hypertask agents create [options]
Options:
--name <display_name> (required)
Agent display name
--project <id>
Project ID (repeatable)
--role <role>
Agent role
--management-key <htmk>
Management key for this request
Example:
hypertask agents create --name <display_name>
-h, --help
Show help
Permanently delete a managed agent
Usage: hypertask agents delete [options]
Options:
--id <agent_id> (required)
Agent ID
--confirm
Confirm permanent deletion
--management-key <htmk>
Management key for this request
Example:
hypertask agents delete --id <agent_id>
-h, --help
Show help
Show one managed agent's mission text, boards, created_at, and revoked state
Usage: hypertask agents get [id] [options]
Options:
--id <agent_id>
Agent ID
--management-key <htmk>
Management key for this request
Example:
hypertask agents get --id <agent_id>
-h, --help
Show help
List managed agents
Usage: hypertask agents list [options]
Options:
--management-key <htmk>
Management key for this request
--query <text>
Free-text search
--filter <key=value>
Structured filter (repeatable). Keys: section, label, assignee, status, updated_since, has_pr
--sort <field>
Sort as field or field:asc|desc
--fields <names>
Comma-separated projection, for example title,url
--limit <n>
Maximum rows to return
--cursor <token>
Opaque cursor from the previous page
Example:
hypertask agents list --management-key <htmk>
-h, --help
Show help
Rename an agent
Usage: hypertask agents rename [options]
Options:
--id <agent_id> (required)
Agent ID
--name <display_name> (required)
New agent display name
--management-key <htmk>
Management key for this request
Example:
hypertask agents rename --id <agent_id> --name <display_name>
-h, --help
Show help
Revoke an agent and invalidate its bearer token
Usage: hypertask agents revoke [options]
Options:
--id <agent_id> (required)
Agent ID
--management-key <htmk>
Management key for this request
Example:
hypertask agents revoke --id <agent_id>
-h, --help
Show help
Rotate an agent bearer token and print the replacement once
Usage: hypertask agents rotate-token [options]
Options:
--id <agent_id> (required)
Agent ID
--management-key <htmk>
Management key for this request
Example:
hypertask agents rotate-token --id <agent_id>
-h, --help
Show help
Rename an agent, change visibility, or add/remove it from projects
Usage: hypertask agents update [options]
Options:
--id <agent_id> (required)
Agent ID
--name <display_name>
New agent display name; the only change allowed when set
--add-project <id>
Project ID to add (repeatable)
--remove-project <id>
Project ID to remove (repeatable)
--visibility <TEAM|PRIVATE>
Agent visibility; the only change allowed per request
--management-key <htmk>
Management key for this request
Example:
hypertask agents update --id <agent_id>
-h, --help
Show help
Manage signed mention and assignment webhooks for an agent
Usage: hypertask agents webhook <command>
Commands:
get
Show configuration, contract, and recent deliveries
configure
Create or update an agent webhook
rotate-secret
Rotate and print the signing secret once
Example:
hypertask agents webhook get --agent <agent_id>
-h, --help
Show help
Create or update an agent webhook
Usage: hypertask agents webhook configure [options]
Options:
--agent <agent_id>
Owned agent UUID; defaults to self for an agent token
--url <https_url>
Public HTTPS receiver URL
--project <id>
Limit delivery to one board
--all-boards
Remove the board filter
--event <name>
Event name (repeatable)
--enabled
Enable delivery
--disabled
Disable delivery
Example:
hypertask agents webhook configure --agent <agent_id>
-h, --help
Show help
Show configuration, contract, and recent deliveries
Usage: hypertask agents webhook get [options]
Options:
--agent <agent_id>
Owned agent UUID; defaults to self for an agent token
Example:
hypertask agents webhook get --agent <agent_id>
-h, --help
Show help
Rotate and print the signing secret once
Usage: hypertask agents webhook rotate-secret [options]
Options:
--agent <agent_id>
Owned agent UUID; defaults to self for an agent token
Example:
hypertask agents webhook rotate-secret --agent <agent_id>
-h, --help
Show help
Run the AI Task Writer, Write with AI, and text rewrites
Usage: hypertask ai <command>
Commands:
write
Draft or rewrite task content with the AI Task Writer
improve
Rewrite text with one of the editor's slash-menu AI commands
Example:
hypertask ai write <prompt> --project <id>
-h, --help
Show help
Rewrite text with one of the editor's slash-menu AI commands
Usage: hypertask ai improve [text] [options]
Options:
--command <name>
improve-readability (default), fix-spelling, summarize, make-shorter, or translate:<language> (e.g. translate:German)
--project <id>
Project ID (carries the team's AI settings)
--task <ticket>
Ticket to resolve the project from
Example:
hypertask ai improve --command <name>
-h, --help
Show help
Draft or rewrite task content with the AI Task Writer
Usage: hypertask ai write <prompt> [options]
Options:
--project <id>
Project ID (defaults to the task's board)
--task <ticket>
Ticket to use as context
--mode <task-writer|write-with-ai>
task-writer drafts a description, write-with-ai drafts a comment
--instructions <text>
Extra custom instructions for this run
--apply
Write the result back to the task (requires --task)
Example:
hypertask ai write <prompt> --project <id>
-h, --help
Show help
Print a paste-ready command list (--json gives the full catalog with every option)
Usage: hypertask capabilities
Example:
hypertask capabilities
-h, --help
Show help
Manage comments
Usage: hypertask comment <command>
Commands:
list
List comments on a task. Piped output is plain, tab-separated, complete, and machine-readable (no truncation, no color codes) - safe to parse directly without --json.
add
Add comment to task
react
Add an emoji reaction to a comment
unreact
Remove your emoji reaction from a comment
update
Update comment
delete
Delete comment
Example:
hypertask comment list <ticket-or-task-id> --project <id>
-h, --help
Show help
Add comment to task
Usage: hypertask comment add <ticket-or-task-id> [options]
Options:
--project <id>
Project ID; treats a numeric task reference as its board index
--text <text>
Comments and descriptions are HTML. Wrap content in block tags. Never embed images; attach files with --attach. Bare text is wrapped in paragraphs.
--body <body>
Alias for --text
--file <path>
Read comment text from file; use --markdown for Markdown
--kind <question|qa|done>
Post a question, QA result, or completion comment for people; omitted kind leaves chatter routing to the server (agents may be saved to the log without notifications)
--markdown
Send the comment unchanged for server-side Markdown conversion
--reply-to-comment-id <id>
Invoking comment ID when an agent answers a direct comment mention
--reply-to-invocation-id <id>
Invocation notification ID when an agent answers a description mention
--attach <path-or-url>
Attach local file or http(s) URL to comment (repeatable)
--improve
Run the text through the AI writer before posting (default: improve-readability)
--improve-command <name>
Which AI rewrite to run with --improve: improve-readability (default), fix-spelling, summarize, make-shorter, or translate:<language>
Example:
hypertask comment add <ticket-or-task-id> --project <id>
-h, --help
Show help
Delete comment
Usage: hypertask comment delete <id>
Example:
hypertask comment delete <id>
-h, --help
Show help
List comments on a task. Piped output is plain, tab-separated, complete, and machine-readable (no truncation, no color codes) - safe to parse directly without --json.
Usage: hypertask comment list <ticket-or-task-id> [options]
Options:
--project <id>
Project ID; treats a numeric task reference as its board index
--query <text>
Free-text search
--filter <key=value>
Structured filter (repeatable). Keys: section, label, assignee, status, updated_since, has_pr
--sort <field>
Sort as field or field:asc|desc
--fields <names>
Comma-separated projection, for example title,url
--limit <n>
Maximum rows to return
--cursor <token>
Opaque cursor from the previous page
Example:
hypertask comment list <ticket-or-task-id> --project <id>
-h, --help
Show help
Add an emoji reaction to a comment
Usage: hypertask comment react <id> [options]
Options:
--emoji <emoji> (required)
Emoji to add
Example:
hypertask comment react <id> --emoji <emoji>
-h, --help
Show help
Remove your emoji reaction from a comment
Usage: hypertask comment unreact <id> [options]
Options:
--emoji <emoji> (required)
Emoji to remove
Example:
hypertask comment unreact <id> --emoji <emoji>
-h, --help
Show help
Update comment
Usage: hypertask comment update <id> [options]
Options:
--text <text> (required)
New comment text (plain text, Markdown or HTML; auto-converted to <p> blocks, blank line = paragraph break)
Example:
hypertask comment update <id> --text <text>
-h, --help
Show help
Get user context, projects, and agent information
Usage: hypertask context
Example:
hypertask context
-h, --help
Show help
Create and resolve durable human decision requests
Usage: hypertask decision [ticket] [options] <command>
Options:
--question <text>
Question for legacy create grammar
--option <value>
Decision option for legacy create grammar (repeat two to ten times)
Commands:
create
Create a decision request for a task
list
List decision requests for a task
get
Get a decision request
answer
Answer a decision request (human tokens only)
cancel
Cancel a pending decision request
Example:
hypertask decision create <ticket> --question <text>
-h, --help
Show help
Answer a decision request (human tokens only)
Usage: hypertask decision answer <id> [options]
Options:
--option <value> (required)
Exact option returned by get/list
--note <text>
Optional note
--confirm
Confirm this final answer
--project <id>
Project ID when the ticket prefix is ambiguous
Example:
hypertask decision answer <id> --option <value>
-h, --help
Show help
Cancel a pending decision request
Usage: hypertask decision cancel <id> [options]
Options:
--confirm
Confirm cancellation
--project <id>
Project ID when the ticket prefix is ambiguous
Example:
hypertask decision cancel <id> --confirm
-h, --help
Show help
Create a decision request for a task
Usage: hypertask decision create <ticket> [options]
Options:
--question <text> (required)
Question for the human
--option <value>
Decision option (repeat two to ten times)
--project <id>
Project ID when the ticket prefix is ambiguous
Example:
hypertask decision create <ticket> --question <text>
-h, --help
Show help
Get a decision request
Usage: hypertask decision get <id> [options]
Options:
--project <id>
Project ID when the ticket prefix is ambiguous
Example:
hypertask decision get <id> --project <id>
-h, --help
Show help
List decision requests for a task
Usage: hypertask decision list <ticket-or-id> [options]
Options:
--status <pending|answered|cancelled>
Filter by status
--project <id>
Project ID when the ticket prefix is ambiguous
Example:
hypertask decision list <ticket-or-id> --status <pending|answered|cancelled>
-h, --help
Show help
Create and manage comment/description drafts for tasks
Usage: hypertask draft <command>
Commands:
create
Create a draft for a task. Add --comment to create draft for comment, else draft created for description.
list
List current draft(s) for a ticket
update
Update an existing draft
publish
Publish a draft — creates the actual comment or updates the task description from the draft
delete
Delete a draft
Example:
hypertask draft create <ticket> --text <text>
-h, --help
Show help
Create a draft for a task. Add --comment to create draft for comment, else draft created for description.
Usage: hypertask draft create <ticket> [options]
Options:
--text <text>
Draft text (plain text or markdown; converted to HTML automatically)
--comment
If provided, draft is created for comment; otherwise description draft
--project <id>
Project ID when the ticket prefix is ambiguous
Example:
hypertask draft create <ticket> --text <text>
-h, --help
Show help
Delete a draft
Usage: hypertask draft delete <draft-id> [options]
Options:
--project <id>
Project ID when the ticket prefix is ambiguous
Example:
hypertask draft delete <draft-id> --project <id>
-h, --help
Show help
List current draft(s) for a ticket
Usage: hypertask draft list <ticket> [options]
Options:
--project <id>
Project ID when the ticket prefix is ambiguous
Example:
hypertask draft list <ticket> --project <id>
-h, --help
Show help
Publish a draft — creates the actual comment or updates the task description from the draft
Usage: hypertask draft publish <draft-id> [options]
Options:
--project <id>
Project ID when the ticket prefix is ambiguous
Example:
hypertask draft publish <draft-id> --project <id>
-h, --help
Show help
Update an existing draft
Usage: hypertask draft update <draft-id> [options]
Options:
--text <text> (required)
New draft text (plain text or markdown; converted to HTML automatically)
--project <id>
Project ID when the ticket prefix is ambiguous
Example:
hypertask draft update <draft-id> --text <text>
-h, --help
Show help
File anonymous AI feedback. Free text (note and error) is not stored; agents should pick a category. AI agents: run this on your own when a hypertask command fails unexpectedly. Never include task, board or comment content.
Usage: hypertask feedback [note] [options]
Options:
--category <value>
Feedback category: call_failed, empty_result, unexpected_result, auth_failed, slow, user_reported_broken, other (default: other)
--tool <command name>
Hypertask command that failed
--status <http status>
HTTP status from 100 to 599
--error-code <slug>
Error code slug
--error <message>
Accepted for compatibility; free text is not stored
--surface <cli|agent>
Feedback surface (default: cli)
--json
Print the raw JSON response
Example:
hypertask feedback --category <value>
-h, --help
Show help
Manage custom fields (Number/Text/Select/Date) on a project's tasks
Usage: hypertask fields <command>
Commands:
list
List custom fields defined on a project. Piped output is plain, tab-separated, complete, and machine-readable (no truncation, no color codes) - safe to parse directly without --json.
create
Create a custom field on a project (idempotent by name)
set
Set a custom field's value on a task (auto-creates the field if missing)
get
Print a task's custom field values
delete
Delete a custom field (and all its values) — by --field-id, or --project + --name
Example:
hypertask fields list --project <id>
-h, --help
Show help
Create a custom field on a project (idempotent by name)
Usage: hypertask fields create [options]
Options:
--project <id> (required)
Project ID
--name <name> (required)
Field name
--type <type>
Field type
--options <json>
JSON array of choices for --type Select, e.g. '["Low","Medium","High"]'
Example:
hypertask fields create --project <id> --name <name>
-h, --help
Show help
Delete a custom field (and all its values) — by --field-id, or --project + --name
Usage: hypertask fields delete [options]
Options:
--field-id <uuid>
Field ID
--project <id>
Project ID (with --name, resolves the field id via list)
--name <name>
Field name (with --project, resolves the field id via list)
Example:
hypertask fields delete --field-id <uuid>
-h, --help
Show help
Print a task's custom field values
Usage: hypertask fields get <ticket>
Example:
hypertask fields get <ticket>
-h, --help
Show help
List custom fields defined on a project. Piped output is plain, tab-separated, complete, and machine-readable (no truncation, no color codes) - safe to parse directly without --json.
Usage: hypertask fields list [options]
Options:
--project <id> (required)
Project ID
Example:
hypertask fields list --project <id>
-h, --help
Show help
Set a custom field's value on a task (auto-creates the field if missing)
Usage: hypertask fields set <ticket-or-task-id> [options]
Options:
--name <name> (required)
Field name
--value <value> (required)
Field value
Example:
hypertask fields set <ticket-or-task-id> --name <name> --value <value>
-h, --help
Show help
Manage notifications
Usage: hypertask inbox <command>
Commands:
list
List notifications. Piped output is plain, tab-separated, complete, and machine-readable (no truncation, no color codes) - safe to parse directly without --json.
composition
Show counts describing one board's inbox load
archive
Archive notifications
unarchive
Restore archived notifications to the inbox
Example:
hypertask inbox list
-h, --help
Show help
Archive notifications
Usage: hypertask inbox archive <ids...>
Example:
hypertask inbox archive <ids...>
-h, --help
Show help
Show counts describing one board's inbox load
Usage: hypertask inbox composition [options]
Options:
--project <id> (required)
Project ID
Example:
hypertask inbox composition --project <id>
-h, --help
Show help
List notifications. Piped output is plain, tab-separated, complete, and machine-readable (no truncation, no color codes) - safe to parse directly without --json.
Usage: hypertask inbox list
Example:
hypertask inbox list
-h, --help
Show help
Restore archived notifications to the inbox
Usage: hypertask inbox unarchive <ids...>
Example:
hypertask inbox unarchive <ids...>
-h, --help
Show help
Manage project labels
Usage: hypertask labels <command>
Commands:
list
List available labels for a project. Piped output is plain, tab-separated, complete, and machine-readable (no truncation, no color codes) - safe to parse directly without --json.
create
Create a new label in a project
Example:
hypertask labels list --project <id>
-h, --help
Show help
Create a new label in a project
Usage: hypertask labels create [options]
Options:
--project <id> (required)
Project ID
--name <name> (required)
Label name
--color <hex>
Label color
Example:
hypertask labels create --project <id> --name <name>
-h, --help
Show help
List available labels for a project. Piped output is plain, tab-separated, complete, and machine-readable (no truncation, no color codes) - safe to parse directly without --json.
Usage: hypertask labels list [options]
Options:
--project <id> (required)
Project ID
--query <text>
Free-text search
--filter <key=value>
Structured filter (repeatable). Keys: section, label, assignee, status, updated_since, has_pr
--sort <field>
Sort as field or field:asc|desc
--fields <names>
Comma-separated projection, for example title,url
--limit <n>
Maximum rows to return
--cursor <token>
Opaque cursor from the previous page
Example:
hypertask labels list --project <id>
-h, --help
Show help
Login to HyperTask via browser
Usage: hypertask login [options]
Options:
--token <jwt>
JWT token (skip browser auth)
--api-url <url>
API URL
Example:
hypertask login --token <jwt>
-h, --help
Show help
Terminal window
hypertask login --token <token> --human
Signed in as Claude Code (agent of Maria Lopez)
Board: Product Launch
https://app.hypertask.ai/project?id=9142
Next steps your agent can run now:
1. See the board: hypertask task list --project 9142
2. Create a first task: hypertask task create --project 9142 --title "My first task"
3. Read the board rules: hypertask project playbook 9142
Or just ask your agent: "What's on my Hypertask board?"

Token login checks the token right away. On success, it shows who you are signed in as and the newest board across all boards the token can see. A missing title falls back to the short name. The example above uses a fictional write agent and board.

The CLI prints the server's steps: read-only agents get two steps, list and playbook, with no create step. If no board is available, --human says "No board yet. Create one in your Hypertask web app."

JSON is the default output. It keeps success, saved, and configPath, and adds:

FieldWhat it contains
signedInAsThe signed-in identity, including name.
boardThe board's id, title, and url.
nextStepsThe server's suggested steps (three for write agents, two for read-only agents, none without a board), each with a CLI command.
moreBoardsA hint to run hypertask project list when the token can see several boards.

The CLI waits at most about 1.5 seconds for the guide. If it times out or fails because of a network or server error, login still saves the token. It returns the previous saved-token output without the guided start. Saving a token does not mean the check passed.

Logout from HyperTask
Usage: hypertask logout
Example:
hypertask logout
-h, --help
Show help
Poll messages addressed to the authenticated identity
Usage: hypertask messages <command>
Commands:
poll
Return addressed notifications and the next cursor
Example:
hypertask messages poll --since <notification-id>
-h, --help
Show help
Return addressed notifications and the next cursor
Usage: hypertask messages poll [options]
Options:
--since <notification-id>
Return notification IDs greater than this cursor
Example:
hypertask messages poll --since <notification-id>
-h, --help
Show help
Manage task pages
Usage: hypertask pages <command>
Commands:
create
Create a page
get
Get a page
append
Append content to a page; keep the existing content type unless --canvas, --html or --markdown is passed
update
Update a page; keep the existing content type unless --canvas, --html or --markdown is passed
list
List pages by task or project
archive
Archive a page (soft delete)
history
List a page's saved versions
restore
Restore a page from a saved version
search
Search pages
Example:
hypertask pages create --task <id-or-ticket> --title <title>
-h, --help
Show help
Append content to a page; keep the existing content type unless --canvas, --html or --markdown is passed
Usage: hypertask pages append <id> [options]
Options:
--content <content>
Content to append
--markdown-file <path>
Read content to append from a file
--html
Treat content as HTML
--canvas
Treat content as an HTML canvas page (html_canvas)
--markdown
Treat content as Markdown (explicitly change the page type)
Example:
hypertask pages append <id> --content <content>
-h, --help
Show help
Archive a page (soft delete)
Usage: hypertask pages archive <id>
Example:
hypertask pages archive <id>
-h, --help
Show help
Create a page
Usage: hypertask pages create [options]
Options:
--task <id-or-ticket> (required)
Task ID or ticket reference
--title <title> (required)
Page title
--content <content>
Page content
--markdown-file <path>
Read page content from a file
--parent <id>
Parent page ID
--html
Treat content as HTML
--canvas
Treat content as an HTML canvas page (html_canvas)
Example:
hypertask pages create --task <id-or-ticket> --title <title>
-h, --help
Show help
Get a page
Usage: hypertask pages get <id> [options]
Options:
--format <markdown|html>
Content format
Example:
hypertask pages get <id> --format <markdown|html>
-h, --help
Show help
List a page's saved versions
Usage: hypertask pages history <id>
Example:
hypertask pages history <id>
-h, --help
Show help
List pages by task or project
Usage: hypertask pages list [options]
Options:
--task <id-or-ticket>
Task ID or ticket reference
--project <id>
Project ID
Example:
hypertask pages list --task <id-or-ticket>
-h, --help
Show help
Restore a page from a saved version
Usage: hypertask pages restore <id> [options]
Options:
--version <id> (required)
Page version ID
Example:
hypertask pages restore <id> --version <id>
-h, --help
Show help
Search pages
Usage: hypertask pages search <query>
Example:
hypertask pages search <query>
-h, --help
Show help
Update a page; keep the existing content type unless --canvas, --html or --markdown is passed
Usage: hypertask pages update <id> [options]
Options:
--title <title>
New page title
--content <content>
New page content
--markdown-file <path>
Read new page content from a file
--mode <replace|append|prepend>
Update mode
--if-version <n>
Only update this page version
--note <text>
Update note
--html
Treat content as HTML
--canvas
Treat content as an HTML canvas page (html_canvas)
--markdown
Treat content as Markdown (explicitly change the page type)
Example:
hypertask pages update <id> --title <title>
-h, --help
Show help
Show agent presence for a team
Usage: hypertask presence <team-id>
Example:
hypertask presence <team-id>
-h, --help
Show help
Manage projects/boards
Usage: hypertask project <command>
Commands:
list
List all projects. Piped output is plain, tab-separated, complete, and machine-readable (no truncation, no color codes) - safe to parse directly without --json.
show
Show project metadata, ticket prefix, sections, and labels. Piped output is plain, tab-separated, complete, and machine-readable (no truncation, no color codes) - safe to parse directly without --json.
update
Rename a project/board
manifest
Show a project's ordered columns and transition policy
playbook
Show or replace a project's working rules and definition of done
instructions
Show or set a project's custom AI instructions
members
List project members. Piped output is plain, tab-separated, complete, and machine-readable (no truncation, no color codes) - safe to parse directly without --json.
sections
List sections in a project (alias: section list --project <id>). Piped output is plain, tab-separated, complete, and machine-readable (no truncation, no color codes) - safe to parse directly without --json.
invite
Invite user/agent to the board
labels
List available labels for a project. Piped output is plain, tab-separated, complete, and machine-readable (no truncation, no color codes) - safe to parse directly without --json.
label
Manage labels
archive
Archive a board you own (use --restore to put it back)
delete
Permanently delete a board and all its tasks. Requires board owner or admin access and --yes.
create-board
Create a board. Flags: --title <t> --team <id> [--sections a,b,c]. Or a JSON manifest via --manifest <file>/--stdin (team_id, title, sections[], optional labels[], tasks[]).
Example:
hypertask project list --limit <n>
-h, --help
Show help
Archive a board you own (use --restore to put it back)
Usage: hypertask project archive <id> [options]
Options:
--restore
Restore an archived board instead
Example:
hypertask project archive <id> --restore
-h, --help
Show help
Create a board. Flags: --title <t> --team <id> [--sections a,b,c]. Or a JSON manifest via --manifest <file>/--stdin (team_id, title, sections[], optional labels[], tasks[]).
Usage: hypertask project create-board [options]
Options:
--title <title>
Board title (flag mode)
--team <id>
Team/workspace id the board belongs to (flag mode)
--sections <list>
Comma-separated column names (default: To Do,In Progress,Done)
--description <text>
Board description (flag mode)
--labels <list>
Comma-separated label names (flag mode)
--manifest <path>
Path to JSON manifest file
--stdin
Read JSON from stdin (pipe a file: cat manifest.json | hypertask project create-board --stdin)
Example:
hypertask project create-board --title <title>
-h, --help
Show help
Permanently delete a board and all its tasks. Requires board owner or admin access and --yes.
Usage: hypertask project delete <id> [options]
Options:
--yes (required)
Confirm permanent board deletion
Example:
hypertask project delete <id> --yes
-h, --help
Show help
Show or set a project's custom AI instructions
Usage: hypertask project instructions <project-id> [options]
Options:
--text <text>
Replace the custom AI instructions (empty clears them)
--model <model-option-id>
AI model option ID; only valid with --text
Example:
hypertask project instructions <project-id> --text <text>
-h, --help
Show help
Invite user/agent to the board
Usage: hypertask project invite <project-id> [options]
Options:
--user <id|email|agent-uuid>
User id, email, or managed-agent UUID
Example:
hypertask project invite <project-id> --user <id|email|agent-uuid>
-h, --help
Show help
Manage labels
Usage: hypertask project label <command>
Commands:
create
Create a new label in a project
Example:
hypertask project label create --project <id> --name <name>
-h, --help
Show help
Create a new label in a project
Usage: hypertask project label create [options]
Options:
--project <id> (required)
Project ID
--name <name> (required)
Label name
--color <hex>
Label color
Example:
hypertask project label create --project <id> --name <name>
-h, --help
Show help
List available labels for a project. Piped output is plain, tab-separated, complete, and machine-readable (no truncation, no color codes) - safe to parse directly without --json.
Usage: hypertask project labels <project-id>
Example:
hypertask project labels <project-id>
-h, --help
Show help
List all projects. Piped output is plain, tab-separated, complete, and machine-readable (no truncation, no color codes) - safe to parse directly without --json.
Usage: hypertask project list [options]
Options:
--limit <n>
Results per page
--offset <n>
Pagination offset
--query <text>
Free-text search
--filter <key=value>
Structured filter (repeatable). Keys: section, label, assignee, status, updated_since, has_pr
--sort <field>
Sort as field or field:asc|desc
--fields <names>
Comma-separated projection, for example title,url
--cursor <token>
Opaque cursor from the previous page
Example:
hypertask project list --limit <n>
-h, --help
Show help
Show a project's ordered columns and transition policy
Usage: hypertask project manifest <project-id>
Example:
hypertask project manifest <project-id>
-h, --help
Show help
List project members. Piped output is plain, tab-separated, complete, and machine-readable (no truncation, no color codes) - safe to parse directly without --json.
Usage: hypertask project members <project-id>
Example:
hypertask project members <project-id>
-h, --help
Show help
Show or replace a project's working rules and definition of done
Usage: hypertask project playbook <project-id> [options]
Options:
--done <rule>
Definition-of-done rule (repeatable; setting replaces the complete playbook)
--working-rules <text>
Working rules (setting replaces the complete playbook)
--notes <text>
Notes (setting replaces the complete playbook)
--clear
Clear the complete playbook
Example:
hypertask project playbook <project-id> --done <rule>
-h, --help
Show help
List sections in a project (alias: section list --project <id>). Piped output is plain, tab-separated, complete, and machine-readable (no truncation, no color codes) - safe to parse directly without --json.
Usage: hypertask project sections <project-id>
Example:
hypertask project sections <project-id>
-h, --help
Show help
Show project metadata, ticket prefix, sections, and labels. Piped output is plain, tab-separated, complete, and machine-readable (no truncation, no color codes) - safe to parse directly without --json.
Usage: hypertask project show <project-id>
Example:
hypertask project show <project-id>
-h, --help
Show help
Rename a project/board
Usage: hypertask project update <project-id> [options]
Options:
--title <title> (required)
New project/board title
Example:
hypertask project update <project-id> --title <title>
-h, --help
Show help
Manage saved board reports
Usage: hypertask report <command>
Commands:
list
List saved reports on a board
get
Get a saved report including its HTML body
create
Create a saved report
update
Update selected fields on a saved report
delete
Permanently delete a saved report
Example:
hypertask report list --project <id>
-h, --help
Show help
Create a saved report
Usage: hypertask report create <slug> [options]
Options:
--project <id> (required)
Project ID
--title <title> (required)
Report title
--description <text>
Report description
--body <html>
Report HTML body
--html-file <path>
Read report HTML body from a file
Example:
hypertask report create <slug> --project <id> --title <title>
-h, --help
Show help
Permanently delete a saved report
Usage: hypertask report delete <slug> [options]
Options:
--project <id> (required)
Project ID
--confirm
Confirm permanent deletion
Example:
hypertask report delete <slug> --project <id>
-h, --help
Show help
Get a saved report including its HTML body
Usage: hypertask report get <slug> [options]
Options:
--project <id> (required)
Project ID
Example:
hypertask report get <slug> --project <id>
-h, --help
Show help
List saved reports on a board
Usage: hypertask report list [options]
Options:
--project <id> (required)
Project ID
Example:
hypertask report list --project <id>
-h, --help
Show help
Update selected fields on a saved report
Usage: hypertask report update <slug> [options]
Options:
--project <id> (required)
Project ID
--title <title>
New report title
--description <text>
New report description
--clear-description
Clear the report description
--body <html>
New report HTML body
--html-file <path>
Read new report HTML body from a file
Example:
hypertask report update <slug> --project <id>
-h, --help
Show help
Search tasks. Piped output is plain, tab-separated, complete, and machine-readable (no truncation, no color codes) - safe to parse directly without --json.
Usage: hypertask search <query> [options]
Options:
--project <id>
Project ID
--limit <n>
Max results
--query <text>
Free-text search
--filter <key=value>
Structured filter (repeatable). Keys: section, label, assignee, status, updated_since, has_pr
--sort <field>
Sort as field or field:asc|desc
--fields <names>
Comma-separated projection, for example title,url
--cursor <token>
Opaque cursor from the previous page
Example:
hypertask search <query> --project <id>
-h, --help
Show help
Manage sections/columns
Usage: hypertask section <command>
Commands:
list
List sections in a project. Piped output is plain, tab-separated, complete, and machine-readable (no truncation, no color codes) - safe to parse directly without --json.
create
Create a new section in a project
rename
Rename a section in the project
reorder
Move a section after another section in the project
done
Mark a column as finished: reports count its tickets as completed, Inbox Zero clears them, agents stop treating them as blocking
update
Set or clear a column's auto-assign rule
delete
Delete a section in the project
Example:
hypertask section list --project <id>
-h, --help
Show help
Create a new section in a project
Usage: hypertask section create [options]
Options:
--project <id> (required)
Project ID
--title <name> (required)
Section title (e.g. "Backlog", "In Review")
--after <id>
Place new section after this section ID
Example:
hypertask section create --project <id> --title <name>
-h, --help
Show help
Delete a section in the project
Usage: hypertask section delete [options]
Options:
--project <id> (required)
Project ID
--section <id> (required)
Section ID
Example:
hypertask section delete --project <id> --section <id>
-h, --help
Show help
Mark a column as finished: reports count its tickets as completed, Inbox Zero clears them, agents stop treating them as blocking
Usage: hypertask section done [options]
Options:
--project <id> (required)
Project ID
--section <id|name> (required)
Section ID or name
--off
Mark the column as NOT finished
--clear
Remove the setting and fall back to guessing from the column name
Example:
hypertask section done --project <id> --section <id|name>
-h, --help
Show help
List sections in a project. Piped output is plain, tab-separated, complete, and machine-readable (no truncation, no color codes) - safe to parse directly without --json.
Usage: hypertask section list [options]
Options:
--project <id> (required)
Project ID
--query <text>
Free-text search
--filter <key=value>
Structured filter (repeatable). Keys: section, label, assignee, status, updated_since, has_pr
--sort <field>
Sort as field or field:asc|desc
--fields <names>
Comma-separated projection, for example title,url
--limit <n>
Maximum rows to return
--cursor <token>
Opaque cursor from the previous page
Example:
hypertask section list --project <id>
-h, --help
Show help
Rename a section in the project
Usage: hypertask section rename [options]
Options:
--project <id> (required)
Project ID
--section <id> (required)
Section ID
--title <name> (required)
Section title (e.g. "Backlog", "In Review")
Example:
hypertask section rename --project <id> --section <id> --title <name>
-h, --help
Show help
Move a section after another section in the project
Usage: hypertask section reorder [options]
Options:
--project <id> (required)
Project ID
--section <id|name> (required)
Section ID or name
--after <id|name> (required)
Section ID or name to place this section after
Example:
hypertask section reorder --project <id> --section <id|name> --after <id|name>
-h, --help
Show help
Set or clear a column's auto-assign rule
Usage: hypertask section update [options]
Options:
--project <id> (required)
Project ID
--section <id|name> (required)
Section ID or name
--auto-assign <id|none> (required)
Numeric user ID, agent UUID, or none to clear
Example:
hypertask section update --project <id> --section <id|name> --auto-assign <id|none>
-h, --help
Show help
Manage personal and project skills
Usage: hypertask skills <command>
Commands:
list
List personal or project skills. Piped output is plain, tab-separated, complete, and machine-readable (no truncation, no color codes) - safe to parse directly without --json.
get
Get a skill. Piped output is plain, tab-separated, complete, and machine-readable (no truncation, no color codes) - safe to parse directly without --json.
create
Create a personal or project skill
update
Update a skill
delete
Delete a skill
import
Import skills from GitHub
Example:
hypertask skills list --project <id>
-h, --help
Show help
Create a personal or project skill
Usage: hypertask skills create [options]
Options:
--name <name>
Skill name
--slug <slug>
Skill invocation slug
--body <body>
Skill instruction body
--description <description>
Skill description
--argument-hint <hint>
Skill argument hint
--scope <user|project>
Skill scope
--project <id>
Project ID (required for project scope)
--markdown <path>
Read complete skill content from a SKILL.md file
--disabled
Create the skill disabled
Example:
hypertask skills create --name <name>
-h, --help
Show help
Delete a skill
Usage: hypertask skills delete <id>
Example:
hypertask skills delete <id>
-h, --help
Show help
Get a skill. Piped output is plain, tab-separated, complete, and machine-readable (no truncation, no color codes) - safe to parse directly without --json.
Usage: hypertask skills get <id>
Example:
hypertask skills get <id>
-h, --help
Show help
Import skills from GitHub
Usage: hypertask skills import <github-url> [options]
Options:
--scope <user|project>
Skill scope
--project <id>
Project ID (required for project scope)
--dry-run
Preview skills without importing them
--slugs <comma-separated>
Only import these comma-separated skill slugs
Example:
hypertask skills import <github-url> --scope <user|project>
-h, --help
Show help
List personal or project skills. Piped output is plain, tab-separated, complete, and machine-readable (no truncation, no color codes) - safe to parse directly without --json.
Usage: hypertask skills list [options]
Options:
--project <id>
Project ID (omit for personal skills)
Example:
hypertask skills list --project <id>
-h, --help
Show help
Update a skill
Usage: hypertask skills update <id> [options]
Options:
--name <name>
New skill name
--slug <slug>
New skill invocation slug
--body <body>
New skill instruction body
--description <description>
New skill description
--argument-hint <hint>
New skill argument hint
--enabled
Enable the skill
--disabled
Disable the skill
--markdown <path>
Read complete updated skill content from a SKILL.md file
Example:
hypertask skills update <id> --name <name>
-h, --help
Show help
Check authentication status
Usage: hypertask status
Example:
hypertask status
-h, --help
Show help
Manage tasks
Usage: hypertask task <command>
Commands:
list
List tasks with filters. Piped output is plain, tab-separated, complete, and machine-readable (no truncation, no color codes) - safe to parse directly without --json.
next
List the highest-priority unleased tasks in a project
get
Get task details. Piped output is plain, tab-separated, complete, and machine-readable (no truncation, no color codes) - safe to parse directly without --json.
description-history
List a task's saved description versions
description-restore
Restore a task description from a saved version
context
Get a read-only task context pack for agent sessions
tree
Show full parent/subtask hierarchy for a task
link
Link two tasks by numeric ID or ticket number
unlink
Remove the relation between two tasks by numeric ID or ticket number
relations
List relations for a task
related
Find semantically related tasks
create
Create a new task
update
Update a task
assign
Assign a user or agent to a task (idempotent: repeat assign is a no-op)
move-to-inbox
Route a task into a project member's inbox (like the palette action)
unassign
Remove a user or agent from task assignees (use --all with --project to clear one assignee across the board)
move
Move task: use ticket + --section for same board, or numeric task id + --to for another project
move-board
Move task to a different project/board (first arg = numeric task id)
search
Search tasks. Piped output is plain, tab-separated, complete, and machine-readable (no truncation, no color codes) - safe to parse directly without --json.
Example:
hypertask task list --project <id>
-h, --help
Show help
Assign a user or agent to a task (idempotent: repeat assign is a no-op)
Usage: hypertask task assign <ticket> [options]
Options:
--assignee <id>
Numeric user ID, or agent UUID from `projects members <id>`
--self
Assign the calling agent to the task (agent token only, no --assignee needed)
Example:
hypertask task assign <ticket> --assignee <id>
-h, --help
Show help
Get a read-only task context pack for agent sessions
Usage: hypertask task context <ticket-or-id> [options]
Options:
--project <id>
Expected project ID (guards against mismatches)
--summary
Return a shorter recent-comment subset
Example:
hypertask task context <ticket-or-id> --project <id>
-h, --help
Show help
Create a new task
Usage: hypertask task create [options]
Options:
--project <id> (required)
Project ID
--title <text> (required)
Task title
--description <text>
Comments and descriptions are HTML. Wrap content in block tags. Never embed images; attach files with --attach. Bare text is wrapped in paragraphs.
--description-file <path>
Read task description from a local file instead of --description (takes precedence if both given)
--markdown
Send the description unchanged for server-side Markdown conversion
--priority <p>
Priority: urgent, high, medium, low, none
--estimate <n>
Size index: 0 = none, 2-6 = XS,S,M,L,XL
--labels <list>
Comma-separated label names or IDs (repeatable; e.g. "CLI,BUG")
--due <date>
Due date (ISO 8601)
--parent-task <ref>
Parent task: internal id or ticket ref
--section <id|name>
Section ID or name (e.g. 4005 or "Doing")
--assignee <list>
Comma-separated user IDs (e.g. "123" or "123,456,789")
--attach <path-or-url>
Attach local file or http(s) URL after task is created (repeatable)
Example:
hypertask task create --project <id> --title <text>
-h, --help
Show help
List a task's saved description versions
Usage: hypertask task description-history <ticket-or-id>
Example:
hypertask task description-history <ticket-or-id>
-h, --help
Show help
Restore a task description from a saved version
Usage: hypertask task description-restore <ticket-or-id> [options]
Options:
--version <id> (required)
Description version ID
Example:
hypertask task description-restore <ticket-or-id> --version <id>
-h, --help
Show help
Get task details. Piped output is plain, tab-separated, complete, and machine-readable (no truncation, no color codes) - safe to parse directly without --json.
Usage: hypertask task get <ticket-or-task-id> [options]
Options:
--project <id>
Project ID; treats a numeric task reference as its board index
Example:
hypertask task get <ticket-or-task-id> --project <id>
-h, --help
Show help
Link two tasks by numeric ID or ticket number
Usage: hypertask task link <source> <target> [options]
Options:
--type <type>
Relation type
Example:
hypertask task link <source> <target> --type <type>
-h, --help
Show help
List tasks with filters. Piped output is plain, tab-separated, complete, and machine-readable (no truncation, no color codes) - safe to parse directly without --json.
Usage: hypertask task list [options]
Options:
--project <id>
Project ID
--search <query>
Search tasks by keyword instead of listing. When set, only --project scoping is applied; other list filters are ignored.
--section <id|name>
Section column ID or name (name requires --project)
--assigned-to <value>
Assignee (me, unassigned, or user ID)
--created-by <id>
Creator user ID (numeric; server-side filter)
--priority <list>
Comma-separated priorities: urgent,high,medium,low
--labels <list>
Comma-separated label names or IDs (names need --project)
--label <list>
Comma-separated label names or IDs (names need --project)
--sort-by <field>
Sort tasks by: createdAt, updatedAt, dueDate, priority, title
--sort-order <asc|desc>
Set the sort order of results by asc or desc
--limit <n>
Results per page
--offset <n>
Pagination offset
--status <field>
Filter tasks by status (Normal, Archive, Deleted)
--has-due-date
Only tasks that have a due date set
--query <text>
Free-text search
--filter <key=value>
Structured filter (repeatable). Keys: section, label, assignee, status, updated_since, has_pr
--sort <field>
Sort as field or field:asc|desc
--fields <names>
Comma-separated projection, for example title,url
--cursor <token>
Opaque cursor from the previous page
Example:
hypertask task list --project <id>
-h, --help
Show help
Move task: use ticket + --section for same board, or numeric task id + --to for another project
Usage: hypertask task move <ticket-or-task-id> [options]
Options:
--section <name>
Destination section name within same board (e.g. "Doing", "Done")
--to <id>
Target project ID — cross-board move (first arg must be numeric task id)
--to-section <id>
Target section ID in destination project (use with --to)
Example:
hypertask task move <ticket-or-task-id> --section <name>
-h, --help
Show help
Move task to a different project/board (first arg = numeric task id)
Usage: hypertask task move-board <task-id> [options]
Options:
--target-project <id> (required)
Target project ID
--target-section <id>
Target section ID
Example:
hypertask task move-board <task-id> --target-project <id>
-h, --help
Show help
Route a task into a project member's inbox (like the palette action)
Usage: hypertask task move-to-inbox <ticket> [options]
Options:
--user <id> (required)
Recipient user ID (must be a member of the task's project)
Example:
hypertask task move-to-inbox <ticket> --user <id>
-h, --help
Show help
List the highest-priority unleased tasks in a project
Usage: hypertask task next [options]
Options:
--project <id>
Project ID
--label <value>
Label name or ID filter
Example:
hypertask task next --project <id>
-h, --help
Show help
Find semantically related tasks
Usage: hypertask task related <ticket-or-id>
Example:
hypertask task related <ticket-or-id>
-h, --help
Show help
List relations for a task
Usage: hypertask task relations <ticket-or-id>
Example:
hypertask task relations <ticket-or-id>
-h, --help
Show help
Search tasks. Piped output is plain, tab-separated, complete, and machine-readable (no truncation, no color codes) - safe to parse directly without --json.
Usage: hypertask task search <query> [options]
Options:
--project <id>
Project ID
--limit <n>
Max results
Example:
hypertask task search <query> --project <id>
-h, --help
Show help
Show full parent/subtask hierarchy for a task
Usage: hypertask task tree [options]
Options:
--ticket <ticket>
Ticket number
--task-id <id>
Numeric task ID
--depth <n>
Max levels deep to show (default: full tree)
Example:
hypertask task tree --ticket <ticket>
-h, --help
Show help
Remove a user or agent from task assignees (use --all with --project to clear one assignee across the board)
Usage: hypertask task unassign [ticket] [options]
Options:
--assignee <id>
Numeric user ID (removes every row shown under that user in `tasks get`, including agent-linked rows) or agent UUID from `projects members <id>`
--self
Unassign the calling agent
--project <id>
Project ID (required with --all; with a numeric ticket, prefers board index then falls back to list id)
--all
Unassign the chosen person from every Normal, Archive, and Deleted task on --project
Example:
hypertask task unassign --assignee <id>
-h, --help
Show help
Remove the relation between two tasks by numeric ID or ticket number
Usage: hypertask task unlink <source> <target>
Example:
hypertask task unlink <source> <target>
-h, --help
Show help
Update a task
Usage: hypertask task update <ticket-or-task-id> [options]
Options:
--title <text>
New title
--description <text>
Comments and descriptions are HTML. Wrap content in block tags. Never embed images; attach files with --attach. Bare text is wrapped in paragraphs.
--description-file <path>
Read new description from a local file instead of --description (takes precedence if both given)
--markdown
Send the description unchanged for server-side Markdown conversion
--pull-request <url>
Link a GitHub pull request to the task
--priority <p>
New priority
--estimate <n>
Size index: 0 = none, 2-6 = XS,S,M,L,XL
--due <date>
New due date
--clear-due
Remove the task's due date
--status <s>
New status: Normal, Archive, Deleted
--section <id|name>
Section ID or name (e.g. 4005 or "Doing")
--project <id>
Project ID; treats a numeric task reference as its board index
--assignee <list>
Comma-separated user IDs (e.g. "123" or "123,456,789"). An empty value clears every assignee.
--clear-assignees
Remove every assignee from the task
--labels <list>
Replace the ticket's entire label set. Repeatable/comma-separated for this call only. Does not append. Use --add-label to keep existing labels.
--add-labels <list>
Comma-separated label names or IDs to add, keeping existing labels (repeatable; e.g. "QA")
--add-label <list>
Alias of --add-labels. Add labels without dropping the ones already on the ticket (repeatable).
--remove-labels <list>
Comma-separated label names or IDs to remove, keeping other labels (repeatable)
--remove-label <list>
Alias of --remove-labels. Remove labels without dropping the ones you did not name (repeatable).
--parent-task <ref>
Parent task: internal id or ticket ref
--clear-parent
Detach this task from its parent
--attach <path>
Attach local file to task after update (repeatable)
Example:
hypertask task update <ticket-or-task-id> --title <text>
-h, --help
Show help
Discover teams and their IDs
Usage: hypertask teams <command>
Commands:
list
List teams available to the current user
Example:
hypertask teams list
-h, --help
Show help
List teams available to the current user
Usage: hypertask teams list
Example:
hypertask teams list
-h, --help
Show help
Track time
Usage: hypertask time <command>
Commands:
start
Start tracking time for a task
stop
Stop tracking time for a task
pause
Pause the running timer for a task
resume
Resume the paused timer for a task
status
Show time-tracking status for a task
log
Log time with optional note/date, or subtract from your latest completed entry with negative minutes (no metadata)
update
Update a completed time entry; provide at least one of --minutes, --date or --note
delete
Delete a time entry
running
List running timers
report
Show a time report
Example:
hypertask time start <task>
-h, --help
Show help
Delete a time entry
Usage: hypertask time delete <entry-id>
Example:
hypertask time delete <entry-id>
-h, --help
Show help
Log time with optional note/date, or subtract from your latest completed entry with negative minutes (no metadata)
Usage: hypertask time log <task> <minutes> [options]
Options:
--date <YYYY-MM-DD>
Move the entry to a local calendar date
--timezone-offset-minutes <n>
Timezone offset used with --date
--note <text>
Note for the new entry
Example:
hypertask time log <task> <minutes> --date <YYYY-MM-DD>
-h, --help
Show help
Pause the running timer for a task
Usage: hypertask time pause <task>
Example:
hypertask time pause <task>
-h, --help
Show help
Show a time report
Usage: hypertask time report [options]
Options:
--board <id>
Filter by board
--task <id>
Filter by task
--user <id|me>
Filter by numeric user id or "me"
--from <date>
Filter from date
--to <date>
Filter to date
--running
Only include running timers
Example:
hypertask time report --board <id>
-h, --help
Show help
Resume the paused timer for a task
Usage: hypertask time resume <task>
Example:
hypertask time resume <task>
-h, --help
Show help
List running timers
Usage: hypertask time running
Example:
hypertask time running
-h, --help
Show help
Start tracking time for a task
Usage: hypertask time start <task>
Example:
hypertask time start <task>
-h, --help
Show help
Show time-tracking status for a task
Usage: hypertask time status <task>
Example:
hypertask time status <task>
-h, --help
Show help
Stop tracking time for a task
Usage: hypertask time stop <task>
Example:
hypertask time stop <task>
-h, --help
Show help
Update a completed time entry; provide at least one of --minutes, --date or --note
Usage: hypertask time update <entry-id> [options]
Options:
--minutes <n>
Replacement duration in minutes
--date <YYYY-MM-DD>
Move the entry to a local calendar date
--timezone-offset-minutes <n>
Timezone offset used with --date
--note <text>
Replace the entry note
Example:
hypertask time update <entry-id> --minutes <n>
-h, --help
Show help
Manage authentication tokens
Usage: hypertask token <command>
Commands:
refresh
Refresh the current JWT token
set-management-key
Save a management key for agent-management commands
Example:
hypertask token refresh
-h, --help
Show help
Refresh the current JWT token
Usage: hypertask token refresh
Example:
hypertask token refresh
-h, --help
Show help
Save a management key for agent-management commands
Usage: hypertask token set-management-key <key>
Example:
hypertask token set-management-key <key>
-h, --help
Show help
Update HyperTask CLI to the latest version
Usage: hypertask update
Example:
hypertask update
-h, --help
Show help
Manage user profile
Usage: hypertask user <command>
Commands:
update
Update current user profile
Example:
hypertask user update --name <displayName>
-h, --help
Show help
Update current user profile
Usage: hypertask user update [options]
Options:
--name <displayName>
Display name
--photo <url>
Profile photo URL
Example:
hypertask user update --name <displayName>
-h, --help
Show help
Manage views for projects
Usage: hypertask view <command>
Commands:
list
List all active views in your projects. If --project is provided, all personal and public views are displayed. Piped output is plain, tab-separated, complete, and machine-readable (no truncation, no color codes) - safe to parse directly without --json.
get
Fetch view details for provided id
create
Create a saved filtered view
update
Update a saved view
delete
Delete a saved view
switch
Switch the highlighted board tab to a saved view
Example:
hypertask view list --project <id>
-h, --help
Show help
Create a saved filtered view
Usage: hypertask view create [options]
Options:
--project <id> (required)
Project ID
--title <text> (required)
View title
--visibility <value>
Visibility: Public or Private
--label <name>
Filter by label name (repeatable)
--assignee <userId>
Filter by assignee: numeric user ID or agent UUID (repeatable)
--match <mode>
Filter matching: ALL or ANY
--sort-mode <mode>
Sort mode: Manual, Priority, DueDate, Size, CreatedAt, or UpdatedAt
--sort-order <order>
Sort order: Ascending or Descending
--subtasks <mode>
Subtasks: None=hidden; Parent=parents + count; Flattened=rows; Card=on parent cards; Flattened_Card=rows + cards
--default
Set this view as the board default
Example:
hypertask view create --project <id> --title <text>
-h, --help
Show help
Delete a saved view
Usage: hypertask view delete <viewId>
Example:
hypertask view delete <viewId>
-h, --help
Show help
Fetch view details for provided id
Usage: hypertask view get <id>
Example:
hypertask view get <id>
-h, --help
Show help
List all active views in your projects. If --project is provided, all personal and public views are displayed. Piped output is plain, tab-separated, complete, and machine-readable (no truncation, no color codes) - safe to parse directly without --json.
Usage: hypertask view list [options]
Options:
--project <id>
Project ID
--visibility <value>
Filter views by 'Public' or 'Private'
--limit <n>
Results per page
--offset <n>
Pagination offset
Example:
hypertask view list --project <id>
-h, --help
Show help
Switch the highlighted board tab to a saved view
Usage: hypertask view switch <viewId>
Example:
hypertask view switch <viewId>
-h, --help
Show help
Update a saved view
Usage: hypertask view update <viewId> [options]
Options:
--title <text>
New view title
--visibility <value>
Visibility: Public or Private
--label <name>
Replace label filters (repeatable)
--assignee <userId>
Replace assignee filters (repeatable)
--clear-labels
Clear all label filters
--clear-assignees
Clear all assignee filters
--match <mode>
Filter matching: ALL or ANY
--sort-mode <mode>
Sort mode: Manual, Priority, DueDate, Size, CreatedAt, or UpdatedAt
--sort-order <order>
Sort order: Ascending or Descending
--subtasks <mode>
Subtasks: None=hidden; Parent=parents + count; Flattened=rows; Card=on parent cards; Flattened_Card=rows + cards
--default
Set this view as the board default
Example:
hypertask view update <viewId> --title <text>
-h, --help
Show help
Manage signed mention and assignment webhooks for an agent
Usage: hypertask webhook <command>
Commands:
get
Show configuration, contract, and recent deliveries
configure
Create or update an agent webhook
test
Queue a real signed webhook.test delivery
replay
Replay one delivery with a new delivery ID
rotate-secret
Rotate and print the signing secret once
delete
Delete the webhook and delivery history
Example:
hypertask webhook get --agent <agent_id>
-h, --help
Show help
Create or update an agent webhook
Usage: hypertask webhook configure [options]
Options:
--agent <agent_id>
Owned agent UUID; defaults to self for an agent token
--url <https_url>
Public HTTPS receiver URL
--project <id>
Limit delivery to one board
--all-boards
Remove the board filter
--event <name>
Event name (repeatable)
--enabled
Enable delivery
--disabled
Disable delivery
Example:
hypertask webhook configure --agent <agent_id>
-h, --help
Show help
Delete the webhook and delivery history
Usage: hypertask webhook delete [options]
Options:
--agent <agent_id>
Owned agent UUID; defaults to self for an agent token
--confirm
Confirm permanent deletion
Example:
hypertask webhook delete --agent <agent_id>
-h, --help
Show help
Show configuration, contract, and recent deliveries
Usage: hypertask webhook get [options]
Options:
--agent <agent_id>
Owned agent UUID; defaults to self for an agent token
Example:
hypertask webhook get --agent <agent_id>
-h, --help
Show help
Replay one delivery with a new delivery ID
Usage: hypertask webhook replay <delivery-id> [options]
Options:
--agent <agent_id>
Owned agent UUID; defaults to self for an agent token
Example:
hypertask webhook replay <delivery-id> --agent <agent_id>
-h, --help
Show help
Rotate and print the signing secret once
Usage: hypertask webhook rotate-secret [options]
Options:
--agent <agent_id>
Owned agent UUID; defaults to self for an agent token
Example:
hypertask webhook rotate-secret --agent <agent_id>
-h, --help
Show help
Queue a real signed webhook.test delivery
Usage: hypertask webhook test [options]
Options:
--agent <agent_id>
Owned agent UUID; defaults to self for an agent token
Example:
hypertask webhook test --agent <agent_id>
-h, --help
Show help