> ## 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.

# Installation

> Install and maintain the Elementum CLI, TypeScript SDK, and coding-agent playbooks.

<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>

The EDK includes two separately installed parts:

* 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. On Windows, run the Linux x64 toolchain inside WSL2. The TypeScript SDK runs anywhere Node.js 24 or newer runs.

## Install the CLI

Run the installer:

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

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:

```bash theme={null}
elementum init
elementum --version
```

`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 on Windows with WSL2

Use an x64 Ubuntu 22.04 or 24.04 distribution. ARM64 WSL and Alpine or other musl-based distributions are not supported.

Install Ubuntu once from an elevated PowerShell or Windows Terminal:

```powershell theme={null}
wsl --install -d Ubuntu
```

After any required restart, open Ubuntu and install the prerequisites, Node.js, and the CLI:

```bash theme={null}
sudo apt update
sudo apt install -y curl tar gnupg ca-certificates
curl -fsSL https://deb.nodesource.com/setup_24.x | sudo -E bash -
sudo apt install -y nodejs
curl -fsSL https://install.elementum.tools | sh
source ~/.bashrc
elementum init --check
```

Keep EDK workspaces on the Linux filesystem, such as `~/elementum-workspace`, rather than under `/mnt/c/`. In VS Code or Cursor, install the WSL extension and select **Reopen Folder in WSL** so the editor, Node.js, auth profiles, and `elementum` CLI all run inside Ubuntu.

## Install the SDK and TypeScript

Create a package workspace that will contain your Elementum organization folders:

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

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:

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

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](/edk/playbooks) for selective installation and inspection commands.

## Verify the installation

Run these checks from your package workspace:

```bash theme={null}
elementum init --check
elementum playbooks status
npx tsc --version
```

After you authenticate and create an organization workspace, run `elementum init` again from that organization folder to converge its local scaffolding.

## Update the toolchain

Check for an available compatibility train without changing the installation:

```bash theme={null}
elementum update --check
```

Update to the current stable toolchain:

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

Use `elementum update --dry-run` to download and verify an update without activating it. After an update, run:

```bash theme={null}
elementum init --check
elementum playbooks status
```

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](/edk/authentication), then review the complete workflow in the [EDK overview](/edk/getting-started).