Skip to content

Projects and milestones

A project groups cards across boards; a milestone is an ordered step inside one project.

Every command here also takes --json and --help — see the overview.

Every project in the workspace, with its target date and lead. A project groups cards from any board.

Terminal window
supi project list

Who may run it

  • A person: viewer or above in the workspace.
  • An agent token: the read scope.

Calls GET /v1/projects

Prints one project per line; --json for the server’s response.

Exit status 0 on success. 1 when:

  • there is no usable credential, or the server refuses it (401) or the act (403), or answers any other error

Example

Terminal window
supi project list

Declares a project in the workspace. Cards from any board can then be grouped under it.

Terminal window
supi project add <name> [--description <text>] [--target YYYY-MM-DD] [--lead <userId>]
argument meaning
<name> the project’s name
flag type default meaning
--description <text> string none what the project is for
--target YYYY-MM-DD date, YYYY-MM-DD no target date the target date; must be a date in YYYY-MM-DD form (checked before anything is sent)
--lead <userId> string no lead the person who leads it

Who may run it

  • A person: admin or above in the workspace.
  • An agent token: the plan scope.

Calls POST /v1/projects

Prints JSON: the created project.

Exit status 0 on success. 1 when:

  • <name> is missing
  • --target is not YYYY-MM-DD
  • there is no usable credential, or the server refuses it (401) or the act (403), or answers any other error

Example

Terminal window
supi project add 'Q4 hardening' --target 2026-12-15 --description 'auth and tenancy fixes'

One project and its milestones, ordered by their sort order and then by name.

Terminal window
supi project show <projectId>
argument meaning
<projectId> the project (see supi project list)

Who may run it

  • A person: viewer or above in the workspace.
  • An agent token: the read scope.

Calls GET /v1/projects/:projectId

Prints the project and its milestones; --json for the server’s response.

Exit status 0 on success. 1 when:

  • <projectId> is missing
  • there is no usable credential, or the server refuses it (401) or the act (403), or answers any other error

Example

Terminal window
supi project show prj_5b10…

Removes a project. Cards that carried it keep the id and show nothing for it.

Terminal window
supi project rm <projectId>
argument meaning
<projectId> the project

Who may run it

  • A person: admin or above in the workspace.
  • An agent token: refused, whatever scopes it carries.

Calls DELETE /v1/projects/:projectId

Prints Deleted <projectId>.; --json for { deleted }.

Exit status 0 on success. 1 when:

  • <projectId> is missing
  • there is no usable credential, or the server refuses it (401) or the act (403), or answers any other error

Example

Terminal window
supi project rm prj_5b10…

Adds a milestone to a project. Milestones are shown in --sort order, then by name.

Terminal window
supi milestone add <projectId> <name> [--target YYYY-MM-DD] [--sort <n>]
argument meaning
<projectId> the project it belongs to
<name> the milestone’s name
flag type default meaning
--target YYYY-MM-DD date, YYYY-MM-DD no target date the target date; must be a date in YYYY-MM-DD form (checked before anything is sent)
--sort <n> number the server’s default order its position within the project, ascending

Who may run it

  • A person: admin or above in the workspace.
  • An agent token: the plan scope.

Calls POST /v1/projects/:projectId/milestones

Prints JSON: the created milestone.

Exit status 0 on success. 1 when:

  • <projectId> or <name> is missing
  • --target is not YYYY-MM-DD, or --sort is not a number
  • there is no usable credential, or the server refuses it (401) or the act (403), or answers any other error

Example

Terminal window
supi milestone add prj_5b10… 'Beta' --target 2026-11-15 --sort 1

Removes one milestone without touching its project. Cards that carried it keep the id.

Terminal window
supi milestone rm <milestoneId>
argument meaning
<milestoneId> the milestone (see supi project show)

Who may run it

  • A person: admin or above in the workspace.
  • An agent token: refused, whatever scopes it carries.

Calls DELETE /v1/milestones/:milestoneId

Prints Deleted <milestoneId>.; --json for { deleted }.

Exit status 0 on success. 1 when:

  • <milestoneId> is missing
  • there is no usable credential, or the server refuses it (401) or the act (403), or answers any other error

Example

Terminal window
supi milestone rm mst_2c7e…