> ## Documentation Index
> Fetch the complete documentation index at: https://synthetiq.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Entity commands

> Manage published entities — apps and services in the cloud

An **entity** is a published app or service in the Synthetiq platform. The
`entity` commands mirror the platform's entities API and operate on a single
entity by its ID.

<Note>
  There is no `entity list` — the platform has no list-all-entities endpoint.
  Discover entity IDs with [`store browse`](/docs/platform-docs/cli/store#browse) or
  [`shared list`](/docs/platform-docs/cli/store#shared-list), both of which show an
  `ID` column.
</Note>

## create

Create a new entity (metadata only — publishing a version is a separate, future step):

```bash theme={null}
synthetiq entity create <slug> --type <type> --name <name> [--description <text>]
```

| Flag                   | Required | Description                           |
| ---------------------- | -------- | ------------------------------------- |
| `--type <type>`        | Yes      | `app`, `service`, or `chat_extension` |
| `--name <name>`        | Yes      | Display name                          |
| `--description <text>` | No       | Description                           |
| `--json`               | No       | Output as JSON                        |

## get

```bash theme={null}
synthetiq entity get <entity-id> [--json]
```

Shows the entity's metadata, active version, and version count.

## details

```bash theme={null}
synthetiq entity details <entity-id> [--json]
```

Enriched view: contributors, dependencies, and store/publish status.

## update

```bash theme={null}
synthetiq entity update <entity-id> [--name <name>] [--description <text>]
```

Pass `--description ""` to clear the description.

## delete

```bash theme={null}
synthetiq entity delete <entity-id> [--force]
```

Deletes the entity and all its versions. Prompts for confirmation unless `--force`.

## set-active

```bash theme={null}
synthetiq entity set-active <entity-id> --version <version>
```

`--version` accepts either a version string (e.g. `2026.06.10-153042`) or a version ID.

## version

Manage an entity's versions.

```bash theme={null}
synthetiq entity version list <entity-id> [--json]
synthetiq entity version download <entity-id> --version <version> [--output <path>]
synthetiq entity version delete <entity-id> --version <version> [--force]
```

`download` writes the version's package to `<slug>-<version>.zip` by default.

<Note>
  Publishing a new version (push) requires local packaging and is not yet
  available in the CLI — it lands with the filesystem command pass.
</Note>

## share

Manage who an entity is shared with.

```bash theme={null}
synthetiq entity share list <entity-id> [--json]
synthetiq entity share add <entity-id> --email <emails...>
synthetiq entity share delete <entity-id> --email <email>
```

To publish an entity to your organization's store instead of sharing with
individuals, use [`store publish`](/docs/platform-docs/cli/store#publish).

## publisher

Manage who can publish new versions of an entity.

```bash theme={null}
synthetiq entity publisher list <entity-id> [--json]
synthetiq entity publisher add <entity-id> --user-id <user-id>
synthetiq entity publisher delete <entity-id> --user-id <user-id>
synthetiq entity publisher me <entity-id> [--json]
```

Find user IDs with `entity share list` or `entity publisher list`.