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 is a signed toolchain for authentication, pulling, building, planning, and applying.
@elementumai/edk is the credential-free TypeScript SDK used by your workspace.
Use Node.js 24 or newer. The CLI supports macOS on Apple Silicon or Intel and Linux x64 with glibc. The TypeScript SDK runs anywhere Node.js 24 or newer runs.
Install the CLI
Run the installer:
The installer places elementum in ~/.elementum/bin and updates your shell profile. Open a new terminal after installation, or reload the applicable profile.
Then initialize and verify the managed toolchain:
elementum init is idempotent. It checks the installed compatibility train, authentication, SDK version and namespace, workspace layout, and provider identity. It does not sign you in or migrate deployment state.
Install the SDK and TypeScript
Create a package workspace that will contain your Elementum organization folders:
The SDK does not contain credentials and does not call the Elementum platform. Authenticated operations run through the CLI toolchain.
Install coding-agent playbooks
Install the bundled playbooks into the current project:
The default destination is ./.agents/skills. Add --global to install under ~/.agents/skills, or use --copy-to <path> for a specific Agent Skills directory.
See Playbooks for selective installation and inspection commands.
Verify the installation
Run these checks from your package workspace:
After you authenticate and create an organization workspace, run elementum init again from that organization folder to converge its local scaffolding.
Check for an available compatibility train without changing the installation:
Update to the current limited-release toolchain:
Use elementum update --dry-run to download and verify an update without activating it. After an update, run:
If a playbook is stale, reinstall it from the updated toolchain with elementum playbooks install --yes.
Next steps
Sign in and create an organization workspace in Authentication, then review the complete workflow in the EDK overview.
