# kindgi projects

> Find projects, for the commands that take `--project=<id>` (list / get-default / get), make and rename them (create / rename), and put one in production (production)

## `kindgi projects`

**Synopsis**

```sh signature
kindgi projects <command>
```

Find projects, for the commands that take `--project=<id>` (list / get-default / get), make and rename them (create / rename), and put one in production (production).

**Commands**

| Command                                                                                                                | Description                                                                                            |
| ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| [`kindgi projects list`](https://docs.kindgi.com/v0.1.10/reference/cli/projects.md#kindgi-projects-list)               | List the tenant's projects.                                                                            |
| [`kindgi projects get-default`](https://docs.kindgi.com/v0.1.10/reference/cli/projects.md#kindgi-projects-get-default) | The tenant's Default project, the one used when none is named.                                         |
| [`kindgi projects get`](https://docs.kindgi.com/v0.1.10/reference/cli/projects.md#kindgi-projects-get)                 | One project, by id.                                                                                    |
| [`kindgi projects create`](https://docs.kindgi.com/v0.1.10/reference/cli/projects.md#kindgi-projects-create)           | Make a project.                                                                                        |
| [`kindgi projects rename`](https://docs.kindgi.com/v0.1.10/reference/cli/projects.md#kindgi-projects-rename)           | Change a project's name, its slug, or both.                                                            |
| [`kindgi projects production`](https://docs.kindgi.com/v0.1.10/reference/cli/projects.md#kindgi-projects-production)   | Put a project in production (`on`), take it out (`off`), or say whether it's in production (`status`). |

**See also**

- [Organize work by org and project](https://docs.kindgi.com/v0.1.10/guides/projects/organize-by-org-and-project.md)

### `kindgi projects list`

**Synopsis**

```sh signature
kindgi projects list [--limit=<n>] [--cursor=<c>]
```

List the tenant's projects.

**Options**

| Option             | Default              | Description                                                      |
| ------------------ | -------------------- | ---------------------------------------------------------------- |
| `--cursor <value>` | none                 | Resume after this cursor, from the previous page's `nextCursor`. |
| `--limit <value>`  | `25` (at most `100`) | The most projects to return.                                     |

Every command also takes the [global flags](https://docs.kindgi.com/v0.1.10/reference/cli.md#global-flags).

**Examples**

List the tenant's projects.

```sh
kindgi projects list
```

Page through them, 10 at a time.

```sh
kindgi projects list --limit=10 --cursor=<cursor>
```

**See also**

- [Organize work by org and project](https://docs.kindgi.com/v0.1.10/guides/projects/organize-by-org-and-project.md)
- [`kindgi projects`](https://docs.kindgi.com/v0.1.10/reference/cli/projects.md#kindgi-projects)

### `kindgi projects get-default`

**Synopsis**

```sh signature
kindgi projects get-default
```

The tenant's Default project, the one used when none is named.

**Options**

Every command also takes the [global flags](https://docs.kindgi.com/v0.1.10/reference/cli.md#global-flags).

**Examples**

Show the tenant's Default project, the one used when no --project is given.

```sh
kindgi projects get-default
```

**See also**

- [Organize work by org and project](https://docs.kindgi.com/v0.1.10/guides/projects/organize-by-org-and-project.md)
- [`kindgi projects`](https://docs.kindgi.com/v0.1.10/reference/cli/projects.md#kindgi-projects)

### `kindgi projects get`

**Synopsis**

```sh signature
kindgi projects get <project-id>
```

One project, by id.

**Options**

Every command also takes the [global flags](https://docs.kindgi.com/v0.1.10/reference/cli.md#global-flags).

**Examples**

Show one project by id.

```sh
kindgi projects get <project-id>
```

**See also**

- [Organize work by org and project](https://docs.kindgi.com/v0.1.10/guides/projects/organize-by-org-and-project.md)
- [`kindgi projects`](https://docs.kindgi.com/v0.1.10/reference/cli/projects.md#kindgi-projects)

### `kindgi projects create`

**Synopsis**

```sh signature
kindgi projects create --name=<name> [--slug=<slug>] [--description=<text>] [--org=<org-id>]
```

Make a project. Prints it, with its id for the `--project=<id>` flags. For tenant admins.

**Options**

| Option                  | Default                                                                                                                                                                    | Description                                                                                                                                                                             |
| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--description <value>` | none                                                                                                                                                                       | What the project is for.                                                                                                                                                                |
| `--name <value>`        | required                                                                                                                                                                   | What people see, e.g. `Support bot`. Required.                                                                                                                                          |
| `--org <value>`         | none (a project in no org)                                                                                                                                                 | The org it belongs to, by id. Without it, none.                                                                                                                                         |
| `--slug <value>`        | the name as a slug: lowercase letters and digits, accents dropped, each run of anything else `-`, at most 63 characters (`Support bot` is `support-bot`, `Café` is `cafe`) | The project's short name, unique in its org (or among projects in none); `kindgi deploy --project <id\|slug>` takes it. Defaults to the name as a slug: `Support bot` is `support-bot`. |

Every command also takes the [global flags](https://docs.kindgi.com/v0.1.10/reference/cli.md#global-flags).

**Examples**

Make a project, with the slug `support-bot`, and print it with its id.

```sh
kindgi projects create --name="Support bot"
```

Make a project in an org, with a slug of your own.

```sh
kindgi projects create --name=Support --slug=support --org=<org-id> --description="Answers the support inbox"
```

From [Organize work by org and project](https://docs.kindgi.com/v0.1.10/guides/projects/organize-by-org-and-project.md):

```sh
npx --yes @kindgi/cli@0.1 projects create --name="Acme shop" --org=<org-id>
```

**See also**

- [Organize work by org and project](https://docs.kindgi.com/v0.1.10/guides/projects/organize-by-org-and-project.md)
- [`kindgi projects`](https://docs.kindgi.com/v0.1.10/reference/cli/projects.md#kindgi-projects)

### `kindgi projects rename`

**Synopsis**

```sh signature
kindgi projects rename <project-id> [--name=<name>] [--slug=<slug>]
```

Change a project's name, its slug, or both. Prints the project. `kindgi deploy --project <id|slug>` then takes the new slug, not the old one. For the project's admins (an admin of its org, or a tenant admin, is one).

**Options**

| Option           | Default   | Description                                                  |
| ---------------- | --------- | ------------------------------------------------------------ |
| `--name <value>` | unchanged | The new name.                                                |
| `--slug <value>` | unchanged | The new slug, unique in its org (or among projects in none). |

Every command also takes the [global flags](https://docs.kindgi.com/v0.1.10/reference/cli.md#global-flags).

**Examples**

Change a project's name; its slug stays.

```sh
kindgi projects rename <project-id> --name=Storefront
```

Change its name and its slug.

```sh
kindgi projects rename <project-id> --name=Storefront --slug=storefront
```

**See also**

- [Organize work by org and project](https://docs.kindgi.com/v0.1.10/guides/projects/organize-by-org-and-project.md)
- [`kindgi projects`](https://docs.kindgi.com/v0.1.10/reference/cli/projects.md#kindgi-projects)

### `kindgi projects production`

**Synopsis**

```sh signature
kindgi projects production <project-id> <on|off|status>
```

Put a project in production (`on`), take it out (`off`), or say whether it's in production (`status`). A run in a project in production is a production run; a run anywhere else is staging. `on` and `off` are for tenant admins.

**Options**

Every command also takes the [global flags](https://docs.kindgi.com/v0.1.10/reference/cli.md#global-flags).

**Examples**

From [Organize work by org and project](https://docs.kindgi.com/v0.1.10/guides/projects/organize-by-org-and-project.md):

```sh
pnpm exec kindgi projects production <project-id> on
pnpm exec kindgi projects production <project-id> status
```

**See also**

- [Organize work by org and project](https://docs.kindgi.com/v0.1.10/guides/projects/organize-by-org-and-project.md)
- [`kindgi projects`](https://docs.kindgi.com/v0.1.10/reference/cli/projects.md#kindgi-projects)
