Skip to content

CLI

Every command of edgekit, the CLI that pulls an organization’s event schemas and decision types into a repository.

edgekit login

Authorize this machine against an EdgeKit organization.

ArgumentMeaning
--console-url <console-url>The console to authorize against (EDGEKIT_CONSOLE_URL wins)
--no-browserPrint the URL instead of opening a browser

edgekit logout

Forget a stored CLI session and revoke it.

ArgumentMeaning
--org <org>Organization slug (defaults to the selected one)

edgekit use [org]

Switch between authorized organizations.

ArgumentMeaning
<org>Organization slug (optional)

edgekit whoami

Show the authorized account and organization.

ArgumentMeaning
--org <org>Organization slug (defaults to the selected one)
--console-url <console-url>The console to ask (EDGEKIT_CONSOLE_URL wins)

edgekit schemas pull

Write this organization's event schemas into the repository.

ArgumentMeaning
--draftPull the authored draft instead of the deployed registry
--checkReport drift and exit non-zero; write nothing
--org <org>Organization slug (defaults to the selected one)
--console-url <console-url>The console to read from (EDGEKIT_CONSOLE_URL wins)

edgekit types pull

Write this organization's decision types into the repository.

ArgumentMeaning
--previewPull the staged preview instead of the deployed document
--checkReport drift and exit non-zero; write nothing
--org <org>Organization slug (defaults to the selected one)
--console-url <console-url>The console to read from (EDGEKIT_CONSOLE_URL wins)