Appearance

Getting Started ​

Install ​

Run commands directly with npx:

bash
npx @ikary/cli init

Or install globally:

bash
npm install -g @ikary/cli
ikary --help

Quick start ​

bash
# 1. Create a new project
ikary init my-app
cd my-app

# 2. Start the local stack (requires Docker)
ikary local start manifest.json

# 3. Open the preview
# Open http://localhost:4500 in your browser

The preview server hot-reloads when you edit manifest.json. The data API runs at http://localhost:4501. Stop everything with ikary local stop.

Validate your manifest ​

bash
ikary validate manifest.json
txt

Validating manifest
manifests/examples/minimal-manifest.yaml

- Parsing and validating...
✔ Manifest is valid

  Entities: 0
  Pages:    1
  Roles:    0

Pass --explain to get fix suggestions when errors are found:

bash
ikary validate manifest.json --explain

Set up Claude Code ​

Run this once in your project directory to write the MCP config and slash command templates:

bash
ikary setup ai

Then open Claude Code and use /ikary-add-entity, /ikary-validate, /ikary-bootstrap, or /ikary-create-primitive to build with AI assistance.

Next steps ​