Skip to main content
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.
This page lists every command surfaced by elementum, grouped by prefix. For guided walkthroughs of how the commands fit together, see Getting Started, EDK Authoring, and Plan and Apply.

​
Getting Help

Print the full command list at any time:
Add --help to any subcommand to see its flags and arguments.
Run elementum --version to confirm which toolchain version you’re on. Keeping the toolchain current avoids mismatches with the @elementumai/edk SDK installed in your workspace.

​
Command Groups

auth login stores an authentication profile locally under the name you pass to --profile. auth status shows the instance, organization, and environment tied to the profile — run it before every plan and apply to confirm the target.Non-interactive environments can provide the same context through environment variables:
Creates the organization workspace at <instance>/<organization>/, imports org-level reference data (CloudLinks, AI provider connectors), and generates the catalog and state support files. Does not pull individual Apps or Elements as editable source — use the resource-level pull commands below for those.
Run from inside the organization workspace (<instance>/<organization>/). Converges the workspace so it mirrors your organization, leaving you ready to author changes.
Each subcommand returns the corresponding resource type from the organization you authenticated against. Use these to check what exists in your org before generating new EDK code or deploying changes.
Fetches an app by its UUID. The optional flags include related resources (fields, agents, automations, search tables) in the result.
Pull a single resource — App, Element, Automation, Agent, Skill, or Search Table — by ID. Useful when you need one piece of an existing definition rather than the whole App.
Generates EDK source files for a resource. --force overwrites existing files; --pull-source pulls the source definition before generating.
plan compares your local source to the deployed environment and reports the structural diff. apply executes that diff, pushing your changes to Elementum. Prefer the narrowest path that covers your dependencies while iterating.See Plan and Apply for plan symbols, staged deployment, and convergence checks.
skills install adds the EDK authoring skill to your project and initializes the supported local agent directories. skills status confirms the installed skill version matches the installed EDK. skills path and skills print inspect the installed skill configuration.
Use elementum skills install rather than adding the skill by hand. The installer initializes the agent directories correctly and enforces the skill/toolchain version match.