CLI Reference

Preview. The tools this page documents are in preview and may change.

Command-line client for the Coelevate Context Repository public API: read, search, stage changes to assets and inspect releases. Asset changes are stage-only - proposed, never landed - while a kit is written directly with kit. Credentials come from the environment: COELEVATE_CLIENT_ID, COELEVATE_CLIENT_SECRET; the API origin from COELEVATE_API_URL (or --api-url).

This page is generated from the command's own argument parser, so it lists exactly what the installed command accepts.

`coelevate-context read`

read one kit or one asset by id.

usage: coelevate-context read [-h] [--api-url API_URL] [--token-url TOKEN_URL]
                              [--json] [--expect-project EXPECT_PROJECT]
                              (--kit-id KIT_ID | --asset-id ASSET_ID)
                              [--version VERSION] [--links]

Give exactly one of --kit-id, --asset-id.

Option	Required	Description
`--api-url`	no	the API origin (default: $COELEVATE_API_URL)
`--token-url`	no	the token endpoint (default: $COELEVATE_TOKEN_URL, else <API URL>/oauth/token)
`--json`	no	print one compact JSON document on stdout; errors become a JSON object on stderr
`--expect-project`	no	refuse to act unless the key resolves to this project (default: $COELEVATE_PROJECT_ID)
`--kit-id`	no	read this kit
`--asset-id`	no	read this asset (any asset type)
`--version`	no	an archived version, else live
`--links`	no	expand resolved in/out edges (assets only)

`coelevate-context search`

lexical text search over your key's context.

usage: coelevate-context search [-h] [--api-url API_URL]
                                [--token-url TOKEN_URL] [--json]
                                [--expect-project EXPECT_PROJECT]
                                --query QUERY [--asset-type ASSET_TYPE]
                                [--max-results MAX_RESULTS]

Option	Required	Default	Description
`--api-url`	no		the API origin (default: $COELEVATE_API_URL)
`--token-url`	no		the token endpoint (default: $COELEVATE_TOKEN_URL, else <API URL>/oauth/token)
`--json`	no		print one compact JSON document on stdout; errors become a JSON object on stderr
`--expect-project`	no		refuse to act unless the key resolves to this project (default: $COELEVATE_PROJECT_ID)
`--query`	yes
`--asset-type`	no		repeatable; omit for every type Repeatable.
`--max-results`	no	`20`

`coelevate-context whoami`

show which project, API, default-token scopes and permitted scopes this key resolves to (never the secret).

usage: coelevate-context whoami [-h] [--api-url API_URL]
                                [--token-url TOKEN_URL] [--json]
                                [--expect-project EXPECT_PROJECT]

Option	Required	Description
`--api-url`	no	the API origin (default: $COELEVATE_API_URL)
`--token-url`	no	the token endpoint (default: $COELEVATE_TOKEN_URL, else <API URL>/oauth/token)
`--json`	no	print one compact JSON document on stdout; errors become a JSON object on stderr
`--expect-project`	no	refuse to act unless the key resolves to this project (default: $COELEVATE_PROJECT_ID)

`coelevate-context doctor`

check configuration, token, project pin, scopes and one read; exit 0/1/2.

usage: coelevate-context doctor [-h] [--api-url API_URL]
                                [--token-url TOKEN_URL] [--json]
                                [--expect-project EXPECT_PROJECT]

Option	Required	Description
`--api-url`	no	the API origin (default: $COELEVATE_API_URL)
`--token-url`	no	the token endpoint (default: $COELEVATE_TOKEN_URL, else <API URL>/oauth/token)
`--json`	no	print one compact JSON document on stdout; errors become a JSON object on stderr
`--expect-project`	no	refuse to act unless the key resolves to this project (default: $COELEVATE_PROJECT_ID)

`coelevate-context assets`

list assets from the index (id, type, label).

usage: coelevate-context assets [-h] [--api-url API_URL]
                                [--token-url TOKEN_URL] [--json]
                                [--expect-project EXPECT_PROJECT]
                                [--asset-type ASSET_TYPE] [--label LABEL]
                                [--limit LIMIT] [--offset OFFSET]

Option	Required	Default	Description
`--api-url`	no		the API origin (default: $COELEVATE_API_URL)
`--token-url`	no		the token endpoint (default: $COELEVATE_TOKEN_URL, else <API URL>/oauth/token)
`--json`	no		print one compact JSON document on stdout; errors become a JSON object on stderr
`--expect-project`	no		refuse to act unless the key resolves to this project (default: $COELEVATE_PROJECT_ID)
`--asset-type`	no		repeatable; omit for every type Repeatable.
`--label`	no		only assets with this label
`--limit`	no	`50`
`--offset`	no	`0`

`coelevate-context kits`

list the kits (id, title, version).

usage: coelevate-context kits [-h] [--api-url API_URL] [--token-url TOKEN_URL]
                              [--json] [--expect-project EXPECT_PROJECT]

Option	Required	Description
`--api-url`	no	the API origin (default: $COELEVATE_API_URL)
`--token-url`	no	the token endpoint (default: $COELEVATE_TOKEN_URL, else <API URL>/oauth/token)
`--json`	no	print one compact JSON document on stdout; errors become a JSON object on stderr
`--expect-project`	no	refuse to act unless the key resolves to this project (default: $COELEVATE_PROJECT_ID)

`coelevate-context asset-types`

list the asset types the context accepts.

usage: coelevate-context asset-types [-h] [--api-url API_URL]
                                     [--token-url TOKEN_URL] [--json]
                                     [--expect-project EXPECT_PROJECT]

Option	Required	Description
`--api-url`	no	the API origin (default: $COELEVATE_API_URL)
`--token-url`	no	the token endpoint (default: $COELEVATE_TOKEN_URL, else <API URL>/oauth/token)
`--json`	no	print one compact JSON document on stdout; errors become a JSON object on stderr
`--expect-project`	no	refuse to act unless the key resolves to this project (default: $COELEVATE_PROJECT_ID)

`coelevate-context changeset`

show the open changeset: revision, base release and staged ops.

usage: coelevate-context changeset [-h] [--api-url API_URL]
                                   [--token-url TOKEN_URL] [--json]
                                   [--expect-project EXPECT_PROJECT]

Option	Required	Description
`--api-url`	no	the API origin (default: $COELEVATE_API_URL)
`--token-url`	no	the token endpoint (default: $COELEVATE_TOKEN_URL, else <API URL>/oauth/token)
`--json`	no	print one compact JSON document on stdout; errors become a JSON object on stderr
`--expect-project`	no	refuse to act unless the key resolves to this project (default: $COELEVATE_PROJECT_ID)

`coelevate-context stage`

stage ops (or un-stage one) in the open changeset.

usage: coelevate-context stage [-h] [--api-url API_URL]
                               [--token-url TOKEN_URL] [--json]
                               [--expect-project EXPECT_PROJECT] (--op OP |
                               --op-file OP_FILE | --ops-file OPS_FILE |
                               --remove-op REMOVE_OP)
                               [--provenance PROVENANCE]
                               [--idempotency-key IDEMPOTENCY_KEY]
                               [--expected-revision EXPECTED_REVISION]
                               [--expected-release EXPECTED_RELEASE]

Give exactly one of --op, --op-file, --ops-file, --remove-op.

Option	Required	Description
`--api-url`	no	the API origin (default: $COELEVATE_API_URL)
`--token-url`	no	the token endpoint (default: $COELEVATE_TOKEN_URL, else <API URL>/oauth/token)
`--json`	no	print one compact JSON document on stdout; errors become a JSON object on stderr
`--expect-project`	no	refuse to act unless the key resolves to this project (default: $COELEVATE_PROJECT_ID)
`--op`	no	one op as a JSON string
`--op-file`	no	one op as a JSON file
`--ops-file`	no	a JSON array of up to 100 ops, staged in one request
`--remove-op`	no	un-stage this op id instead of staging
`--provenance`	no	a JSON object recording where the ops came from
`--idempotency-key`	no	make a retry of this request safe
`--expected-revision`	no	default: read from the changeset just before staging
`--expected-release`	no	default: read from the changeset just before staging

`coelevate-context tag`

look up the release currently holding a tag (read-only).

usage: coelevate-context tag [-h] [--api-url API_URL] [--token-url TOKEN_URL]
                             [--json] [--expect-project EXPECT_PROJECT]
                             --name NAME

Option	Required	Description
`--api-url`	no	the API origin (default: $COELEVATE_API_URL)
`--token-url`	no	the token endpoint (default: $COELEVATE_TOKEN_URL, else <API URL>/oauth/token)
`--json`	no	print one compact JSON document on stdout; errors become a JSON object on stderr
`--expect-project`	no	refuse to act unless the key resolves to this project (default: $COELEVATE_PROJECT_ID)
`--name`	yes	the tag to look up

`coelevate-context release`

list releases, or read one by number or tag.

usage: coelevate-context release [-h] [--api-url API_URL]
                                 [--token-url TOKEN_URL] [--json]
                                 [--expect-project EXPECT_PROJECT]
                                 [--number NUMBER] [--tag TAG] [--limit LIMIT]
                                 [--offset OFFSET]

Option	Required	Default	Description
`--api-url`	no		the API origin (default: $COELEVATE_API_URL)
`--token-url`	no		the token endpoint (default: $COELEVATE_TOKEN_URL, else <API URL>/oauth/token)
`--json`	no		print one compact JSON document on stdout; errors become a JSON object on stderr
`--expect-project`	no		refuse to act unless the key resolves to this project (default: $COELEVATE_PROJECT_ID)
`--number`	no		read this one release
`--tag`	no		the release currently holding this tag
`--limit`	no	`50`
`--offset`	no	`0`

`coelevate-context kit`

write a kit directly (create, patch, add or remove members, revert, retire) or read its journal.

usage: coelevate-context kit [-h] [--api-url API_URL] [--token-url TOKEN_URL]
                             [--json] [--expect-project EXPECT_PROJECT]
                             [--kit-id KIT_ID] [--asset-id ASSET_ID]
                             [--base-version BASE_VERSION] [--body BODY]
                             [--body-file BODY_FILE]
                             {create,patch,add-members,remove-member,revert,retire,journal}

Option	Required	Description
`--api-url`	no	the API origin (default: $COELEVATE_API_URL)
`--token-url`	no	the token endpoint (default: $COELEVATE_TOKEN_URL, else <API URL>/oauth/token)
`--json`	no	print one compact JSON document on stdout; errors become a JSON object on stderr
`--expect-project`	no	refuse to act unless the key resolves to this project (default: $COELEVATE_PROJECT_ID)
`verb`	yes	One of `create`, `patch`, `add-members`, `remove-member`, `revert`, `retire`, `journal`.
`--kit-id`	no	the kit (every verb but create)
`--asset-id`	no	the member to take out (remove-member)
`--base-version`	no	the kit version you read (remove-member, retire)
`--body`	no	create, patch, add-members, revert: the request as a JSON string
`--body-file`	no	create, patch, add-members, revert: the request as a JSON file

`coelevate-context gap`

list, read, record, edit, close (retire) or revert a gap directly, or read its journal.

usage: coelevate-context gap [-h] [--api-url API_URL] [--token-url TOKEN_URL]
                             [--json] [--expect-project EXPECT_PROJECT]
                             [--gap-id GAP_ID] [--state {open,retired,all}]
                             [--kind KIND] [--opened-release OPENED_RELEASE]
                             [--closed-release CLOSED_RELEASE]
                             [--version VERSION] [--body BODY]
                             [--body-file BODY_FILE]
                             {list,get,journal,create,patch,retire,revert}

Option	Required	Default	Description
`--api-url`	no		the API origin (default: $COELEVATE_API_URL)
`--token-url`	no		the token endpoint (default: $COELEVATE_TOKEN_URL, else <API URL>/oauth/token)
`--json`	no		print one compact JSON document on stdout; errors become a JSON object on stderr
`--expect-project`	no		refuse to act unless the key resolves to this project (default: $COELEVATE_PROJECT_ID)
`verb`	yes		One of `list`, `get`, `journal`, `create`, `patch`, `retire`, `revert`.
`--gap-id`	no		the gap (every verb but list and create)
`--state`	no	`open`	list: which gaps (default open) One of `open`, `retired`, `all`.
`--kind`	no		list: only gaps of this kind
`--opened-release`	no		list: only gaps opened in this release
`--closed-release`	no		list: only gaps closed in this release
`--version`	no		get: an archived version, else live
`--body`	no		create, patch, retire, revert: the request as a JSON string
`--body-file`	no		create, patch, retire, revert: the request as a JSON file

On this page