Command reference

Prefix	Entity	Prefix	Entity
`SI-`	Signal	`GL-`	Goal
`IN-`	Insight	`OP-`	Decision brief
`AC-`	Action	`DC-`	Document
`CL-`	Cluster

Authentication

Command	What it does
`squad auth login`	Browser OAuth 2.1 PKCE flow, then auto-selects a workspace when only one is reachable
`squad auth logout`	Clears the stored session and workspace selection
`squad auth status`	Reports whether a session exists, its expiry, and whether it has expired

Workspace

Command	What it does
`squad workspace list`	Every organisation and workspace you can access
`squad workspace select <orgId> <workspaceId>`	Sets the active workspace for later commands
`squad workspace overview`	Mission, top goals, recent signal activity, chain health, open work counts
`squad workspace update`	Edits the current workspace
`squad workspace members`	People in the organisation with their user IDs

squad workspace update takes --name, --description, --mission-statement and --logo-url.Use squad workspace members to find the user ID you need for squad action update --assignee.

Signals

Raw feedback. See Signals for what they are and where they come from.

Command	What it does
`squad signal list`	Browse signals with filters
`squad signal similar <signalId>`	Signals semantically close to a given one
`squad signal ingest`	Push feedback into the evidence chain
`squad signal dismiss <signalId>`	Permanently delete a signal

squad signal list flags: --source, --type, --sentiment, --cluster <uuid>, --since <iso>, --until <iso>, --include-dismissed, --limit, --offset.squad signal similar takes --limit (default 5, max 20).squad signal ingest takes either a single item or a file:

squad signal ingest \
  --content "Export to CSV times out on accounts over 50k rows" \
  --source zendesk \
  --source-url https://support.example.com/tickets/4821 \
  --author "Priya N" \
  --strength 0.8

squad signal ingest --file ./feedback.json

--file points at a JSON array of 1 to 50 signal objects. Other flags: --title, --occurred-at <iso>. Content is deduplicated server-side, then clustered and distilled asynchronously.

squad signal dismiss deletes the signal. It cannot be recovered. --reason records why in the command output.

Clusters

Recurring themes across signals. See Signal clusters.

Command	What it does
`squad cluster list`	Clusters with sizes and labels
`squad cluster get <clusterId>`	Label, stats, member signals and linked insights

squad cluster list flags: --type, --include-unlabeled, --limit, --offset.

Insights

Command	What it does
`squad insight list`	Insights ranked by combined score
`squad insight update <insightId>`	Set category or status, link or unlink a goal

squad insight list flags: --goal <goalId>, --category, --min-score, --status, --limit, --offset.squad insight update flags: --category, --status, --link-goal, --unlink-goal. Titles and descriptions come from the pipeline and are not editable.

Actions

Command	What it does
`squad action list`	Ranked actions, filtered
`squad action context <actionId>`	The action, its insight, the evidence and the goals it serves
`squad action status <actionId> <status>`	Move it through its lifecycle
`squad action update <actionId>`	Edit metadata, assign, or link it

squad action list flags: --statuses <suggested,in_progress,completed,dismissed>, --assignee <userId|me>, --insight <insightId>, --priority <P0,P1,P2>, --include-snoozed, --limit, --offset.squad action status takes start, complete, dismiss or snooze, plus --note to append a line to the action’s notes.

squad action status AC-12 complete --note "shipped in PR #482"

squad action context is the one to reach for before writing code against an action. It returns the customer quotes and source links behind the work in a single call.

Goals

Command	What it does
`squad goal list`	Goals ordered by importance
`squad goal create`	Create a strategic goal
`squad goal update <goalId>`	Edit title, description or importance

squad goal list flags: --min-importance, --limit, --offset.squad goal create requires --title and --description, and accepts --importance (1 to 5, default 3).squad goal update flags: --title, --description, --importance.

Documents

See Knowledge documents.

Command	What it does
`squad document list`	Documents with paths and tags
`squad document create`	Create a document from markdown
`squad document update <documentId>`	Replace body or title, manage tags

squad document list flags: --tag, --limit, --offset.squad document create requires --title and --markdown, and accepts --directory and --tags (comma separated). A near-identical title returns the existing document rather than creating a duplicate.squad document update flags: --markdown, --title, --add-tags, --remove-tags.

Decision briefs

One-pagers. See One-pagers.

Command	What it does
`squad brief list`	Briefs with status and recommendation
`squad brief generate`	Start AI generation of a brief
`squad brief status <onePagerId> <status>`	Move a brief through review

squad brief list flags: --status <building,draft,in_review,finalised,failed>, --type <decision|prd>, --source-insight, --limit, --offset.squad brief generate takes --action <AC-N>, --insight <IN-N> or --retry <OP-N>, plus --type <decision|prd>. Generation is asynchronous, so poll the returned OP- ID with squad get.

squad brief generate --action AC-12 --type decision
squad get OP-7

squad brief status accepts draft, in_review or finalised. The building and failed states belong to generation and cannot be set by hand.

Integrations

Command	What it does
`squad integration list`	Connected feedback sources and their sync health

Connect and configure sources in the app. See Integrations.

Activity, search and fetch

Command	What it does
`squad activity`	Workspace change feed, newest first
`squad search <query>`	Keyword search across the workspace
`squad get <id>`	Fetch any entity by display ID or UUID

squad activity flags: --entity-types <list>, --actor-type <human\|agent>, --agent-id, --limit, --after <cursor>. See Activity.squad search flags: --types <signal,insight,action,goal,document,cluster>, --limit. Matching is on title and content, so pick real keywords.squad get accepts --include evidence on insights to pull the supporting signals with their source links. Documents come back as markdown.

squad get IN-42 --include evidence

Squad CLI

Command reference

Display IDs

The commands

​Display IDs

​The commands

Display IDs

The commands