ikas

The official ikas CLI — a command-line interface for building and managing ikas apps.

Create, link, configure, and develop ikas applications directly from your terminal.

Requirements

• Node.js >= 20
• npm, pnpm, or yarn

Installation

Install globally:

npm install -g ikas

Or with pnpm / yarn:

pnpm add -g ikas
yarn global add ikas

After installation, the ikas binary is available on your PATH:

ikas --help

You can also run it without installing via npx:

npx ikas --help

Quick Start

# 1. Authenticate with your ikas account
ikas auth login

# 2. Create a new ikas app in the current directory
ikas app init

# 3. Link an existing app to the current directory
ikas app link

# 4. Start developing
ikas app dev

Theme Quick Start

# 1. Scaffold a new theme project
ikas theme init

# 2. (Or) link an existing theme directory to a storefront editor URL
ikas theme link --editor-url https://<store>.myikas.com/admin/storefront/<storefrontId>/editor/<storefrontThemeId>

# 3. Start the theme dev server and route editor traffic
ikas theme dev

Commands

Authentication

| Command | Description | | -------------------- | --------------------------------- | | ikas auth login | Authenticate with ikas | | ikas auth logout | Clear local authentication | | ikas auth me | Show the currently logged-in user |

App

| Command | Description | | ---------------------------- | ---------------------------------------------------- | | ikas app init | Initialize a new ikas app in the current directory | | ikas app link | Link an existing ikas app to the current directory | | ikas app info | Show information about the current app | | ikas app configure | Open the Partners page to configure the current app | | ikas app install | Install the current app to a selected store | | ikas app dev | Open the current app in an authorized store | | ikas app clean-routes | Clean generated routes |

Theme

| Command | Description | | -------------------------- | -------------------------------------------------------------------------- | | ikas theme init | Scaffold a new ikas theme project (blank or full template) | | ikas theme link | Link the current directory to a storefront editor URL | | ikas theme dev | Start the theme dev server, open a tunnel, and route storefront editor traffic | | ikas theme clean-routes | Clean design asset websocket routing for the linked theme |

Run ikas <group> --help or ikas <group> <command> --help for full usage and options.

Global Flags

| Flag | Description | | --------------------- | ------------------------ | | -h, --help | Show help | | -v, --version | Show CLI version | | --verbose | Enable verbose logging | | --quiet | Suppress non-error output |

Configuration

The CLI stores its configuration under ~/.ikas/:

• ~/.ikas/config.json — user configuration and tokens

Environment Variables

| Variable | Description | | ------------- | ----------------------------------------------------- | | IKAS_* | Non-interactive overrides for CLI configuration values | | NO_COLOR=1 | Disable colored output |

Exit Codes

| Code | Meaning | | ---- | -------------- | | 0 | Success | | 1 | Generic error | | 2 | Invalid usage | | 3 | Auth error | | 4 | Network error |

Security

• Tokens and secrets are never logged.
• Credentials are stored in your OS keychain when available, otherwise in ~/.ikas/config.json with restricted permissions.
• All traffic uses TLS; corporate proxies are respected via standard HTTPS_PROXY / HTTP_PROXY env vars.

Troubleshooting

• Authentication loops or stale sessions: run ikas auth logout and sign in again.
• Commands fail silently: re-run with --verbose to see debug logs.
• Colors rendering incorrectly in CI: set NO_COLOR=1.

Resources

• 📖 Docs & guides: https://builders.ikas.com
• 🐛 Issues & feedback: [email protected]