Overview

Understand how the Elementum Development Kit represents and manages Elementum solutions.

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.

Current preview compatibility train: 0.9.5. Follow Installation to verify the CLI, SDK, and coding-agent playbooks before starting work.

The Elementum Development Kit (EDK) is a code-first toolkit for representing Apps, Elements, Tables, standalone Tasks, fields, Automations, Agents, platform agentic Skills, Search Tables, File Readers, Visual Flows, Approval Processes, organization resources, and user experiences as reviewable TypeScript source.

Use the EDK when you want typed references, source control, coding-agent assistance, and a clear plan before changing an organization. For visual configuration without code, start with Build an App.

How the EDK works

The EDK has three cooperating layers:

• The @elementumai/edk SDK provides typed builders and references. It is credential-free and never calls the platform.
• The elementum CLI manages installation, authentication, pull, build, plan, and apply operations.
• EDK state tracks live identities so plan can calculate each add, change, replacement, and removal.

Authored TypeScript uses names and typed tokens rather than platform UUIDs. Existing objects are pulled by namespace, reconstructed as editable source, and connected to EDK state. Generated catalogs let one entity reference another without copying opaque identifiers.

Understand the workspace

A package workspace can contain one or more organization workspaces:

<package-workspace>/
  package.json
  <instance>/
    <organization>/
      org.ts
      organization.ts
      tsconfig.json
      backend.tf              # optional; recommended for shared workspaces
      apps/
      elements/
      tables/
      tasks/
      generated/
        catalog.ts
      .tf/
        in/
        out/

The organization folder is the deployment boundary. Planning from a nested app or file still builds and reviews the full organization workspace.

Edit organization.ts and authored files under apps/, elements/, tables/, and tasks/. Do not hand-edit:

• org.ts, which is refreshed from organization reference identities
• generated/catalog.ts, which is regenerated from the authored file tree
• .tf/in/, which belongs to platform exports
• .tf/out/, which belongs to elementum build

Start here

Quickstart

Set up your first EDK workspace.

Installation

Install and update the EDK.

Authentication

Sign in and manage profiles.

Build with the EDK

Authoring

Edit organization resources and solution entities as typed source.

Playbooks

Guide coding agents through EDK work.

Plan and apply

Review and apply EDK changes.

Design

Design with EDK

Design processes and record experiences.

Record experiences

Define what each person sees and does.

Design validation

Review scenarios and confirm the design.

Test and troubleshoot

Acceptance testing

Verify complete business outcomes.

Troubleshooting

Diagnose and resolve EDK issues.