CLI Reference

Reference for the main elementum commands used to set up, author, review, and apply EDK changes.

Limited Release. The EDK is currently in limited release and is not available to all customers. Commands, generated file layouts, and package APIs may change before general availability. Confirm you’re on the latest EDK version before starting new projects.

The elementum CLI combines EDK workspace commands with platform commands supplied by the managed toolchain. This page lists the current top-level command surface. Add --help to any command or subcommand for its arguments and options.

Get help

elementum --help
elementum <command> --help
elementum <command> <subcommand> --help
elementum --version

Platform commands are loaded dynamically and may vary by toolchain version. The output of elementum --help is the source of truth for your installed version.

Global options

Option	Purpose
--profile <profile>	Use a specific authentication profile. Optional when the organization workspace matches one saved profile.
-V, --version	Print the installed CLI version.
-h, --help	Print help for the current command.

EDK commands

These commands manage the installed toolchain and local EDK workspaces.

Command	Purpose
init	Check and converge the managed installation and current workspace.
update	Update the installed Elementum compatibility train.
migrate	Run explicit workspace migrations for backends or provider sources.
list	List Apps, Elements, users, groups, categories, CloudLinks, AI providers, Automations, or tables.
pull	Pull deployed objects into editable EDK source.
clone	Clone a deployed App as a new local entity.
build	Generate deployment configuration offline. plan and apply run this automatically.
generate	Regenerate catalog files from the current authoring source.
plan	Build the workspace and preview EDK changes.
apply	Build the workspace and apply reviewed EDK changes.
new	Scaffold a new App, Element, Automation, Agent, or agentic Skill authoring file.
canvas	Open an offline workspace explorer or entity preview.
playbooks	Install, update, list, and inspect coding-agent playbooks.
help	Print help for a command.

Common EDK subcommands

Pull existing source

Command	Purpose
pull org --data-only	Refresh organization lookup bags in org.ts.
pull org	Pull editable organization resources into organization.ts and refresh lookup bags.
pull app <namespace>	Pull an App and its supported children with automatic adoption.
pull app <namespace> --with-dependencies	Also pull referenced Apps and Elements not yet in the workspace.
pull element <namespace>	Pull an Element and its supported children with automatic adoption.
pull table <name-or-handle>	Pull an organization-owned Table with automatic adoption.
pull task <namespace>	Pull a standalone Task with automatic adoption.
pull automation <automation-id>	Pull one app-owned Automation by UUID for targeted recovery.

Add --no-adopt only when you intentionally want source without connecting the existing resources to deployment state. Use --max-depth <n> with pull app to limit dependency traversal.

Scaffold new source

Command	Purpose
new app --name <name> --namespace <namespace> --category <category>	Scaffold an organization-root App.
new element --name <name> --namespace <namespace> --category <category>	Scaffold an organization-root Element.
new automation --app <app-ref> --name <name>	Scaffold an app-owned Automation.
new agent --app <app-ref> --name <name>	Scaffold an app-owned Agent.
new skill --app <app-ref> --name <name>	Scaffold an app-owned agentic Skill.

new app and new element register their @catalog references immediately. Run elementum generate [path] after hand edits that change catalog-visible source.

See Quickstart for the core workflow, Playbooks for playbook commands, and Plan and Apply for reviewing changes.

Platform commands

Platform commands operate against Elementum through the managed toolchain. They are still invoked through the same elementum executable.

Agents and AI

Command	Purpose
a2a	Invoke Agents over the A2A protocol.
a2a-skills	Manage A2A skills.
agent-tools	Manage Agent tools.
agents	Manage Agents.
ai-providers	Manage AI providers.
ai-services	Manage AI services.
chat	Start a conversation with an Agent.
conversation	Analyze Agent conversation performance.
interventions	Manage Automation interventions.
skill-tools	Manage agentic Skill tools.
skills	Manage agentic Skills.

Apps and workflows

Command	Purpose
app-flows	Manage App Flows.
approvals	Manage record approvals.
apps	Manage Apps.
automations	Monitor and operate Automations.
dynamic-layouts	Manage typed dashboard layouts.
elements	Manage Elements.
fields	Manage fields.
file-readers	Manage File Readers.
layouts	Manage layouts and stages.
objects	Manage objects.
records	Manage records.
search-tables	Manage AI Search Tables.
tasks	Manage Tasks.
views	Manage object views.

Data and integrations

Command	Purpose
cloudlinks	Manage CloudLinks.
datamines	Manage Datamines.
functions	Manage stored Snowflake functions.
phone-providers	Manage phone providers.
phone-services	Manage phone services.
table	Run table management commands.
tables	Manage tables.
vault	Manage vault entries.

Organization and access

Command	Purpose
access-policies	Manage object access policies.
auth	Sign in and manage authentication profiles.
categories	Manage categories.
deployments	Manage platform Deployments.
environments	Manage environments.
feature-flags	Manage feature flags.
groups	Manage groups.
org	Run organization-level operations.
roles	Manage object roles and membership.
users	Manage users.

Advanced operations

Command	Purpose
completion	Generate shell completion scripts.
destroy	Destroy managed resources using Elementum credentials.
graphql	Execute a raw GraphQL query or mutation.
import	Import resources into state using Elementum credentials.
refs	Show available references from state or the remote API.
state	Run state commands such as mv, list, and show.