hirotm tasks commands list, show by id, create, and change work items on a board: filterable listing, fetch one task by global id, add a card, edit fields, move it to another column, or send it through Trash (delete → restore or purge). Global options and output modes: hirotm CLI.
You need the right CLI permissions on each board—see CLI access policy. Use hirotm boards describe and Lists to look up board slugs, list ids, and group ids. For shared flags (--profile, --client-name), see hirotm CLI.
Access policy
Turn on the toggles your workflow needs in Board settings. If the CLI is not allowed to do something, the command fails with an error message.
For how Trash fits together, see the Trash: delete, restore, and purge section in Concepts.
Task Operations
tasks list
List tasks on a board. --board is required. Optional flags limit by column, group, priority, workflow status, release, or date range (same filters as the former boards tasks command).
| Option | Type | Required | Description |
|---|---|---|---|
--board <id-or-slug> | string | Board id or slug. | |
--list <id> | integer | Only tasks in that column (list). | |
--group <id> | integer | Only tasks in that group (repeat the flag or use commas). | |
--priority <id> | integer | Only tasks with that priority (repeat or commas). | |
--status <id> | string | Only tasks in that workflow status (repeat or commas). | |
--release-id <id> | integer | Only tasks in those releases (repeat or commas; combined with OR). | |
--untagged | flag | Include tasks with no release (used together with --release-id as OR). | |
--date-mode <mode> | string | opened, closed, or any. | |
--from <yyyy-mm-dd> | string | Start of date range (inclusive). | |
--to <yyyy-mm-dd> | string | End of date range (inclusive). | |
--limit <n> | integer | Page size after server-side sort/filter (omit for one full response). | |
--offset <n> | integer | Skip this many tasks (default 0). | |
--page-all | flag | Merge all pages (--limit or 500 per request). | |
--count-only | flag | Print total matches only (Paging); not with --limit, --offset, --page-all, or --fields. | |
--fields <keys> | string | Comma-separated API keys per row. Allowed: taskId, boardId, boardSlug, listId, title, body, groupId, priorityId, status, order, color, emoji, createdAt, updatedAt, closedAt, createdByPrincipal, createdByLabel, releaseId. See Field projection. |
-q / --quiet (with --format ndjson); default field taskId. See Pipe-friendly quiet.
CLI Examples
tasks show
Print one task by global numeric id (GET /api/tasks/:taskId). The API resolves the board and applies readBoard for that board—no --board flag.
| Option | Type | Required | Description |
|---|---|---|---|
<task-id> | integer | Global task id. | |
--fields <keys> | string | Same allowlist as tasks list (see Field projection). |
tasks add
Create a task on a board. You must pass board, list (column), and group. The app fills in a default title if you skip --title.
| Option | Type | Required | Description |
|---|---|---|---|
--board <id-or-slug> | string | Board id or slug. | |
--list <id> | integer | Column (list) id. | |
--group <id> | integer | Task group id. | |
--title <text> | string | Title (default Untitled). | |
--status <id> | string | Workflow status (default open). | |
--priority <id> | integer | Priority row id (omit for built-in none). | |
--release <name-or-none> | string | Release by exact name, or none for no release. Do not use together with --release-id. | |
--release-id <id> | integer | Release by id. Do not use together with --release. Omit both (with board defaults) to let the server auto-assign when that is enabled. | |
--emoji <text> | string | Emoji before the title. | |
--clear-emoji | flag | Store no emoji. | |
--body <text> | string | Body (Markdown). | |
--body-file <path> | string | Read body from a text file. | |
--body-stdin | flag | Read body from the terminal until input ends. |
Add a task "Buy metro tickets" on board bucket-lists in list 2 and group 1.
tasks update
Change any mix of fields on an existing task. The CLI resolves the board from the task id, so there is no --board flag. You must include at least one change flag.
| Option | Type | Required | Description |
|---|---|---|---|
<task-id> | integer | Task id. | |
--title <text> | string | New title. | |
--body <text> | string | Body (Markdown). | |
--body-file <path> | string | Body from a text file. | |
--body-stdin | flag | Body from the terminal until input ends. | |
--status <id> | string | Workflow status id. | |
--list <id> | integer | Move to this list id (column). | |
--group <id> | integer | Task group id. | |
--priority <id> | integer | Priority row id (use built-in none id to reset). | |
--release <name-or-none> | string | Release by name, or none. Not with --release-id. | |
--release-id <id> | integer | Release by id. Not with --release. | |
--color <css> | string | Card color (CSS). | |
--clear-color | flag | Remove card color. | |
--emoji <text> | string | Emoji before the title. | |
--clear-emoji | flag | Remove emoji. |
Set task 101 title to "Done when shipped".
tasks move
Move a task to another column (--to-list), optionally change its status in that column, and choose exactly one ordering hint: --first, --last, --before-task, or --after-task. The CLI resolves the board from the task id.
| Option | Type | Required | Description |
|---|---|---|---|
--to-list <id> | integer | Destination column (list) id. | |
<task-id> | integer | Task id to move. | |
--to-status <id> | string | Status in the destination (omit to keep the current status). | |
--before-task <id> | integer | Place before this task in the destination band. | |
--after-task <id> | integer | Place after this task in the destination band. | |
--first | flag | First in the destination band. | |
--last | flag | Last in the destination band. |
Move task 101 to list 3 at the top.
tasks delete
Send a task to Trash. The CLI resolves the board from the task id for permission checks, confirmation text, and dry-run previews.
| Option | Type | Required | Description |
|---|---|---|---|
<task-id> | integer | Task id. | |
--dry-run | flag | Preview only; do not move to Trash. See Dry-run preview. | |
-y, --yes | flag | Skip the confirmation prompt. |
Move task 101 to Trash (non-interactive).
tasks restore
Bring a task back from Trash. Only the task id is required (no board flag).
| Option | Type | Required | Description |
|---|---|---|---|
<task-id> | integer | Task id (see hirotm trash list tasks if unsure). | |
-y, --yes | flag | Skip the confirmation prompt. |
Restore task 101 from Trash (non-interactive).
tasks purge
Remove a task from Trash permanently. Cannot be undone. Only the task id is required.
| Option | Type | Required | Description |
|---|---|---|---|
<task-id> | integer | Task id already in Trash. | |
--dry-run | flag | Preview only; do not purge. See Dry-run preview. | |
-y, --yes | flag | Skip the confirmation prompt. |
Permanently delete task 101 from Trash (non-interactive).
Learn more
Runhirotm help tasks or hirotm help tasks <subcommand> for the full help text in your installed CLI.