Skip to main content
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.
There is no entity list — the platform has no list-all-entities endpoint. Discover entity IDs with store browse or shared list, both of which show an ID column.

​
create

Create a new entity (metadata only — publishing a version is a separate, future step): 
synthetiq entity create <slug> --type <type> --name <name> [--description <text>]
FlagRequiredDescription
--type <type>Yesapp, service, or chat_extension
--name <name>YesDisplay name
--description <text>NoDescription
--jsonNoOutput as JSON

​
get

synthetiq entity get <entity-id> [--json]
Shows the entity’s metadata, active version, and version count.

​
details

synthetiq entity details <entity-id> [--json]
Enriched view: contributors, dependencies, and store/publish status.

​
update

synthetiq entity update <entity-id> [--name <name>] [--description <text>]
Pass --description "" to clear the description.

​
delete

synthetiq entity delete <entity-id> [--force]
Deletes the entity and all its versions. Prompts for confirmation unless --force.

​
set-active

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. 
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.
Publishing a new version (push) requires local packaging and is not yet available in the CLI — it lands with the filesystem command pass.

​
share

Manage who an entity is shared with. 
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.

​
publisher

Manage who can publish new versions of an entity. 
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.