> ## Documentation Index
> Fetch the complete documentation index at: https://docs.elementum.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Set up an EDK workspace, pull an existing solution, and deploy a small change.

<Warning>
  **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.
</Warning>

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:

```bash theme={null}
curl -fsSL https://install.elementum.tools | sh
```

Create a Node.js workspace and install the SDK and TypeScript:

```bash theme={null}
mkdir elementum-workspace
cd elementum-workspace
npm init -y
npm install @elementumai/edk
npm install --save-dev typescript@^6
```

See [Installation](/edk/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:

```bash theme={null}
elementum playbooks install --yes
elementum playbooks status
```

See [Playbooks](/edk/playbooks) for the available playbooks and management commands.

## 3. Sign in

Create a profile for the organization and environment you want to change:

```bash theme={null}
elementum auth login --profile <profile>
elementum --profile <profile> auth status
```

Confirm that the reported instance, organization, and environment are correct. See [Authentication](/edk/authentication) for OAuth setup and profile management.

## 4. Create the organization workspace

From the Node.js workspace, pull organization references:

```bash theme={null}
elementum --profile <profile> pull org --data-only
```

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:

```bash theme={null}
cd <instance>/<organization>
elementum init
```

## 5. Pull something to change

List the Apps or Elements available in the organization:

```bash theme={null}
elementum list apps
elementum list elements
```

Copy a namespace from the output, then pull that App or Element:

```bash theme={null}
elementum pull app <namespace>
# or
elementum pull element <namespace>
```

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:

```bash theme={null}
npx tsc --noEmit
```

TypeScript reports invalid source and references.

See [EDK Authoring](/edk/authoring) for workspace ownership, identity rules, and builder imports.

## 7. Plan and apply

Review the EDK changes:

```bash theme={null}
elementum plan
```

`plan` builds the current source automatically. Review every add, change, replacement, and destroy operation. Apply only when the plan matches the change you intended:

```bash theme={null}
elementum apply
elementum plan
```

The final plan should report no changes. This confirms that the source, state, and live organization agree.

See [Plan and Apply](/edk/plan-and-apply) for shared backends, recovery, and cross-environment promotion.