---
# Generated by kapten-docs from the CLI's command tree. DO NOT EDIT.
title: "kapten projects"
description: "Create and manage projects."
sidebar:
  label: "projects"
---

Every command takes the [global flags](/cli/reference#global-flags).

## kapten projects create

Creates a project and returns it.

```bash
kapten projects create <body...> [flags]
```

| Argument | Description |
| --- | --- |
| `body...` | The request body, as shorthand or JSON. See [Request bodies](/cli/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:

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

Example:

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

## kapten projects delete

Deletes a project.

```bash
kapten projects delete <project-id> [flags]
```

| Argument | Description |
| --- | --- |
| `project-id` | The unique identifier for the project |

Example:

```bash
kapten projects delete <project-id>
```

## kapten projects get

Returns a project.

```bash
kapten projects get <project-id> [flags]
```

| Argument | Description |
| --- | --- |
| `project-id` | The unique identifier for the project |

Example:

```bash
kapten projects get <project-id>
```

## kapten projects list

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

```bash
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:

```bash
kapten projects list
```

## kapten projects update

Updates a project's name and description.

```bash
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](/cli/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:

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

Example:

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