Skip to main content

crewship project

Projects are the unit of delivery — a named bundle of missions, issues, and crews working toward a target date. They carry status, priority, and health independently, so a planning dashboard can show “in progress / at risk / 60% complete” without reading every issue. Aliases: projects. Defined in cmd/crewship/cmd_project.go.
Every subcommand requires crewship login plus an active workspace. The PATCH/DELETE surface mirrors internal/api/project_handler.go — fields you don’t set with Changed() aren’t sent, so partial updates won’t clobber unrelated columns.

Subcommands

The three verbs written <id-or-slug> accept either. /api/v1/projects/{projectId} keys on the id alone, so the CLI resolves a slug against project list before it builds the URL — update, delete and stats, written <id>, take the id only.

Flags

project create

project update

Every flag is opt-in — only fields the user actually set hit the wire. Pass an explicit empty string to clear a nullable column.

project delete

Examples

List

Create

Get details

Update

Prints Project <id> updated.; --format json prints the full updated project record returned by the server. You can clear a nullable field by passing an empty string explicitly — --description "" removes the description, while omitting the flag leaves it untouched.

Breakdown stats

--format json returns the raw shape for piping into jq.

Delete

Delete unlinks every issue and mission (sets project_id = NULL in the same transaction) so the destroy doesn’t cascade into issue loss — but the project itself is gone. Prompts unless -y.

Milestones

Each project carries an ordered list of milestones (named delivery checkpoints with an optional target date). Backed by /api/v1/projects/{id}/milestones for list/create and /api/v1/milestones/{id} for update/delete (see internal/api/milestone_handler.go). Alias on the parent verb: milestones.
update/delete take the milestone id (not the project id) because milestones are keyed independently once created.

Permissions

Any workspace member can run list, get, stats and milestone list. create, update, milestone create and milestone update require the MANAGER role or higher; MEMBER and VIEWER get API error (403). delete and milestone delete require ADMIN or higher.

Common errors

  • --name is required — create was called without a name.
  • no fields to update — pass at least one of --name/--status/--priority/--health/--lead-id/--lead-type/--start-date/--target-date/--icon/--color/--description — update needs at least one field.
  • API error (409): A project with the slug "..." already exists in this workspace — create with a name whose derived slug is already used in this workspace.
  • API error (404): Project not found / Milestone not found — update with an unknown id (or one from another workspace).
  • workspace_id required — no active workspace; run crewship workspace use <slug> first.

See also

crewship project guest-intake

Read or configure where new Guest requests for this project are filed. Trusted ADMIN/OWNER only; setting requires the existing mutation token scope.
With --crew, reads the current revision and saves exactly once; a stale snapshot returns 409 without retry. The chosen crew must be active in the same workspace and have a live LEAD agent. Its ID, name and configuration revision appear only in this administrative view. New requests start unassigned in Backlog; configuring intake does not grant agent or routine execution access.

crewship project shared <project-id>

Read basic name and description shared with your Guest account. Requires current project Read and Manage; the response includes can_manage and an opaque snapshot version. JSON and YAML use the same field names. Other projects, leads and private activity are not included. Use crewship issue shared projects to list shared project IDs.

crewship project shared update <project-id>

Update the shared project’s name and description with live Read and Manage shares. Use the version you reviewed; the command does not fetch a newer version or retry 409 conflicts. Guest management does not grant project-file writes, milestones, issue deletion, intake configuration or access administration.

crewship project shared milestones <project-id> [milestone-id]

List or read milestones with current project Read and Manage shares. Responses contain only milestone metadata, current action flags and an opaque version. Use --limit (default100, 1–500) and --offset (default0) for the collection. JSON and YAML use the same keys.

crewship project shared milestones create <project-id>

Create an ordered milestone. The authenticated account and audit come from the server; this command cannot select a workspace actor or issue execution context.

crewship project shared milestones update <project-id> <milestone-id>

Replace a reviewed metadata snapshot. All flags are required; empty description or target date clears that field. A409 is returned without refresh or retry.

crewship project shared milestones delete <project-id> <milestone-id>

Remove an empty milestone. Linked issue work is preserved: removal returns409 until a trusted workspace administrator resolves those links.