Skip to main content

CLI Configuration

The CLI supports multiple projects and environments (sandbox/live), allowing you to manage several Ikawaari accounts from a single machine.

View Current Configuration

ikw config list
┌─────────┬─────────┬─────────────┬──────────────────────────────────┬──────────────────────────────────┐
│ project │ current │ environment │ sandboxBaseUrl │ liveBaseUrl │
├─────────┼─────────┼─────────────┼──────────────────────────────────┼──────────────────────────────────┤
│ default │ true │ sandbox │ http://localhost:5000 │ http://localhost:5000 │
└─────────┴─────────┴─────────────┴──────────────────────────────────┴──────────────────────────────────┘

Switch Environment

Toggle between sandbox and live:

# Switch to live
ikw config set environment live

# Switch back to sandbox
ikw config set environment sandbox

Manage Projects

Projects let you work with multiple Ikawaari accounts:

# Create and switch to a new project
ikw config set project my-client

# Switch back to default
ikw config set project default

Each project has its own sandbox and live credentials.

Set Base URL

Override the API base URL (useful for local development or self-hosted instances):

ikw config set base-url http://localhost:5000

Configuration File

The config file is stored at:

OSPath
Linux~/.config/ikw/config.json
macOS~/Library/Application Support/ikw/config.json
Windows%APPDATA%\ikw\config.json

Structure

{
"currentProject": "default",
"projects": {
"default": {
"currentEnvironment": "sandbox",
"environments": {
"sandbox": {
"baseUrl": "https://api.ikawaari.com",
"apiKey": "ik_test_..."
},
"live": {
"baseUrl": "https://api.ikawaari.com",
"apiKey": "ik_live_..."
}
}
}
}
}