CLI reference
Nouns and verbs. Every command takes --json.
Install
Get the symphony command for your system, then sign in. Your token is kept in your system's keychain. Install steps to confirm
symphony login
Commands
| Command | What it does |
|---|---|
symphony login [--device] [--json] | Signs in through the browser and keeps the token in the system keychain. |
symphony logout [--json] | Signs out and deletes the token from the keychain. |
symphony whoami [--json] | Shows the signed-in account. |
symphony skill [--json] | Prints the SKILL.md that matches this version. |
symphony version [--json] | Prints the version. |
symphony update [--json] | Downloads the latest symphony from releases.opensymphony.io and replaces this binary with it. |
symphony mcp [--json] | Serves every tool to an MCP client over stdio, signed in as you. |
symphony tokens [--json] | Lists your personal API keys with their scope, never the keys themselves. |
symphony token create --name <name> --scope <scope> [--json] | Creates a personal API key for a bot or script and prints it once; store it as a secret. It works on the REST API (x-api-key header) and the remote MCP. |
symphony token revoke <id> [--json] | Revokes a personal API key at once; anything using it is refused from then on. |
symphony projects [--page <page>] [--page-size <page_size>] [--json] | Lists the projects with their open task count and next due date, one page at a time. |
symphony statuses --in <project> [--page <page>] [--page-size <page_size>] [--json] | Lists a project’s statuses in board order, each with its category, one page at a time. |
symphony labels [--page <page>] [--page-size <page_size>] [--json] | Lists the labels, shared by every project, one page at a time. |
symphony tasks [--in <project>] [--filter <filter>] [--page <page>] [--page-size <page_size>] [--json] | Lists tasks that are not deleted, in board order, one page at a time. Narrow it by project, status, priority, label, overdue (open and due before today in your time zone), blocked (blocked by an open task) and updated_since. |
symphony task show <ref> [--json] | Shows one task with its relations (blocks, blocked by, related) and its sub-tasks. |
symphony task add <title> --in <project> [--parent <parent>] [--status <status>] [--priority <priority>] [--estimate <estimate>] [--due <due_at>] [--due-tz <due_tz>] [--labels <labels>] [--description <description>] [--json] | Creates a task in a project, by default in its first Todo status. |
symphony task update <ref> [--title <title>] [--project <project>] [--status <status>] [--priority <priority>] [--estimate <estimate>] [--due <due_at>] [--due-tz <due_tz>] [--labels <labels>] [--description <description>] [--json] | Edits a task. Moving it to another project moves its sub-tasks too. |
symphony task done <ref> [--json] | Marks a task done: it takes its project’s first Done status. |
symphony capture <text> [--json] | Files one line as a task, read like quick capture: the first date sets the due day, !urgent, !high, !medium, !low or !1 to !4 the priority, and #name the project. Without #name, the CLI files it to the project it last captured to; offline, the CLI keeps it and files it on its next run. |
symphony project show <project> [--json] | Shows one project with its open task count, next due date and statuses. |
symphony history [<ref>] [--since <since>] [--page <page>] [--page-size <page_size>] [--json] | Lists what changed, oldest first: one task’s changes, or with only since, every task’s changes from that time on. |
symphony comments <ref> [--page <page>] [--page-size <page_size>] [--json] | Lists a task’s comments, oldest first; each body is Markdown. |
symphony comment add <ref> --body <body> [--json] | Adds a comment to a task. |
symphony relation add <ref> --to <to> --kind <kind> [--json] | Relates a task to another: it blocks it, is blocked by it, or is related to it. |
symphony relation remove <ref> --to <to> [--json] | Removes every relation between two tasks, in either direction. |
symphony triage [--page <page>] [--page-size <page_size>] [--json] | Lists the asks waiting in triage, newest first, snoozed ones whose time has passed included. |
symphony ask accept <ask> [--in <project>] [--title <title>] [--status <status>] [--priority <priority>] [--due <due_at>] [--due-tz <due_tz>] [--json] | Makes an ask a task. Each field left out takes the ask’s suggestion: its title, project, priority and due date. |
symphony ask dismiss <ask> [--reason <reason>] [--json] | Dismisses an ask. The person can restore it in the app. |
symphony today [--json] | Shows today in your time zone: Today’s top 3 tasks, the calendar events that overlap the day, and how many asks wait in triage. |
symphony repos [--page <page>] [--page-size <page_size>] [--json] | Lists the git repositories in the folders you allowed (each folder itself, or a folder directly inside it), with the branch, the last commit and how many files have changes. Local only. |
symphony repo log <repo> [--since <since>] [--page <page>] [--page-size <page_size>] [--json] | Lists a git repository’s commits on its current branch, newest first. The repository must be inside a folder you allowed. Local only. |
Output
Text output is short and stable for agents to read. Add --json for structured output: snake_case keys, ISO 8601 dates, and an id and a link on every item.
Offline
Captures made offline wait in a queue and go out when you are back online.