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 quickstart takes you from an empty local folder to an EDK workspace connected to your Elementum organization. Start in a development or test environment and choose a small existing App or Element for your first change.

​
1. Install the EDK

Install the elementum CLI:
Create a Node.js workspace and install the SDK and TypeScript:
See Installation for platform support, updates, and verification.

​
2. Install playbooks

Install the bundled playbooks so your coding agent understands the current EDK workflows and conventions:
See Playbooks for the available playbooks and management commands.

​
3. Sign in

Create a profile for the organization and environment you want to change:
Confirm that the reported instance, organization, and environment are correct. See Authentication for OAuth setup and profile management.

​
4. Create the organization workspace

From the Node.js workspace, pull organization references:
The command creates <instance>/<organization>/ with typed references for items such as CloudLinks, categories, groups, and AI provider connectors. Enter that folder and finish the local setup:

​
5. Pull something to change

List the Apps or Elements available in the organization:
Copy a namespace from the output, then pull that App or Element:
Pulling creates editable TypeScript and connects the existing resources to EDK state without changing the live organization.

​
6. Make the change

Edit the pulled files under apps/ or elements/. Use @catalog for typed references to other authored entities. Check the TypeScript before contacting the platform:
TypeScript reports invalid source and references. See EDK Authoring for workspace ownership, identity rules, and builder imports.

​
7. Plan and apply

Review the EDK changes:
plan builds the current source automatically. Review every add, change, replacement, and destroy operation. Apply only when the plan matches the change you intended:
The final plan should report no changes. This confirms that the source, state, and live organization agree. See Plan and Apply for shared backends, recovery, and cross-environment promotion.