Skip to content
Kapten
Esc
↑↓navigate↵open⌘Jpreview
On this page

kapten projects

Create and manage projects.

Every command takes the global flags.

kapten projects create

Creates a project and returns it.

kapten projects create <body...> [flags]
Argument Description
body... The request body, as shorthand or JSON. See Request bodies.
Flag Description
--rsh-generate-body Print an example request body and exit
--rsh-validate Validate the JSON request body against the OpenAPI schema before sending

Request body fields, * for required:

{
  description*: (string) The description of the project.
  name*: (string pattern:\S minLen:1) The name of the project.
}

Example:

kapten projects create 'description: string, name: string'

kapten projects delete

Deletes a project.

kapten projects delete <project-id> [flags]
Argument Description
project-id The unique identifier for the project

Example:

kapten projects delete <project-id>

kapten projects get

Returns a project.

kapten projects get <project-id> [flags]
Argument Description
project-id The unique identifier for the project

Example:

kapten projects get <project-id>

kapten projects list

Returns the organization’s projects, a page at a time.

kapten projects list [flags]
Flag Description
--filter-with-deleted Include deleted instances (default: false)
--page-limit int Maximum number of records to return (default: 10)
--page-number int Page number (default: 1)

Example:

kapten projects list

kapten projects update

Updates a project’s name and description.

kapten projects update <project-id> <body...> [flags]
Argument Description
project-id The unique identifier for the project
body... The request body, as shorthand or JSON. See Request bodies.
Flag Description
--rsh-generate-body Print an example request body and exit
--rsh-validate Validate the JSON request body against the OpenAPI schema before sending

Request body fields, * for required:

{
  description: (string) The description of the project.
  name: (string pattern:\S minLen:1) The updated name of the project.
}

Example:

kapten projects update <project-id> 'description: string, name: string'

Was this page helpful?