Command reference
deployments project
Projects
| Command | Summary |
|---|---|
deployments project create | Create a project |
deployments project list | List projects |
deployments project show | Show a project |
deployments project update | Update a project |
deployments project archive | Archive a project |
deployments project create
Create a project.
deployments project create --name <name>- Calls
POST /v1/projects(SDKcreateProject). - Needs an organization:
--orgor the saved context. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--name | string | yes | Resource name | |
--slug | string | URL-safe project slug |
Also accepts the global flags.
deployments project list
List projects.
deployments project list- Calls
GET /v1/projects(SDKlistProjects). - Needs an organization:
--orgor the saved context. - Paginated.
--page-sizesets the page size; pass the returned cursor as--cursorfor the next page.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--cursor | string (cursor) | Pagination cursor | ||
--page-size | string (number) | Page size |
Also accepts the global flags.
deployments project show
Show a project.
deployments project show <id>- Calls
GET /v1/projects/{id}(SDKgetProject). - Needs a project:
--projector the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments project update
Update a project.
deployments project update <id>- Calls
PATCH /v1/projects/{id}(SDKupdateProject). - Needs a project:
--projector the saved context. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID | |
--name | string | New project name | ||
--slug | string | New project slug |
Also accepts the global flags.
deployments project archive
Archive a project.
deployments project archive <id>- Calls
DELETE /v1/projects/{id}(SDKarchiveProject). - Needs a project:
--projector the saved context. - Destructive. Live runs ask for confirmation; pass
--yesin scripts or with--json. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID | |
--reason | string | Reason for this operation |
Also accepts the global flags.