# Startup commands: create, get, list

URL: /code/cli/startup/records · Id: `page:code/cli/startup/records`

> The Startup Verbs create, get, list as CLI commands, with inputs, result, refusals and an example.

Reference for [Startup](/business/nouns/startup), one group of [Startup commands](/code/cli/startup).

### Startup.create
Creates a Startup. [Verb page](/business/nouns/startup/create?interface=cli).

```text
npx startup-builder do Startup.create --json '<input>' [--try | --send | --do]
```

Emits `Startup.created`.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | `string` | Yes | The name the Startup trades under. |
| `domain` | `url` | No | The canonical hostname of the Startup. |
| `launchedAt` | `datetime` | No | When the Startup went live. |
| `template` | `string` | No | The slug of the template it extends; the root one when none is named. |
| `idea` | `text` | No | The Idea it starts from, in a sentence, recorded as its Idea. |
| `spendState` | `string` | No | How freely money Limits allow spend: `free`, `tight` (discretionary Limits halved) or `hold` (one-way spend stops). |
| `studio` | [Studio](/business/nouns/studio) | No | A Studio founds and builds its Startups and runs Plays across them. |
| `company` | [Company](/business/nouns/company) | No | The holding Company is the Startup’s owner of record: it signs its Agreements and owns its profit rights. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `startup` | [Startup](/business/nouns/startup) | Yes | The Startup. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
npx startup-builder do Startup.create --json '{"name":"Leaseline"}'
```

### Startup.get
Returns one Startup by id. [Verb page](/business/nouns/startup/get?interface=cli).

```text
npx startup-builder do Startup.get --json '<input>' [--try]
```

Reads only: it emits no Event.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | The id of the Startup. |
| `at` | `string` | No | A time or Version name: the record as it stood then. Unset: as it stands now. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `startup` | [Startup](/business/nouns/startup) | Yes | The Startup. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
npx startup-builder do Startup.get --json '{"id":"startup_l3hr1EnUGY"}'
```

### Startup.list
Returns Startups, newest first, one page at a time. [Verb page](/business/nouns/startup/list?interface=cli).

```text
npx startup-builder do Startup.list --json '<input>' [--try]
```

Reads only: it emits no Event.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | `integer` | No | At most this many records, up to 100. The default is 20. |
| `after` | `string` | No | The cursor from the previous page. |
| `where` | `string` | No | A filter over the properties, such as `paidAt = null and total.amount > 500`. |
| `sort` | `string` | No | Properties to sort by, comma-separated; a leading minus sorts descending. |
| `total` | `boolean` | No | True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above. |
| `facets` | `string` | No | Properties to count by value, comma-separated, returned as `meta.facets`. |
| `fields` | `string` | No | Properties to return on each record, comma-separated; `$id` and `$type` always return. |
| `include` | `string` | No | Related records to embed in place of their URLs, comma-separated. |
| `depth` | `integer` | No | How many levels of related records to embed. The default is 1. |
| `q` | `string` | No | Words to match across the text properties, ranked by relevance. |
| `match` | `string` | No | Ranks the search by `words`, or `meaning`; words is the default. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `startups` | list of [Startup](/business/nouns/startup) | Yes | One page of Startups. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
npx startup-builder do Startup.list --json '{"limit":20}'
```