Command Reference

Complete reference for all Kamui CLI commands.

Global Options

Options available for all commands.

Authentication

kamui login

Authenticate with your GitHub account.

kamui login

Opens a browser for GitHub OAuth authentication. After successful authentication, the token is stored locally.

kamui logout

Log out and clear credentials.

kamui logout

Projects

kamui projects list

List all projects.

kamui projects list

Example output:

ID                                    NAME            PLAN  REGION  APPS  DATABASES
5f809f2f-0787-40ca-9a43-a3a59edb5400  my-project      free  tokyo   2     1
21065335-ade9-4e63-bfcc-284760fa3957  another-app     pro   tokyo   3     0

JSON output:

kamui projects list -o json

kamui projects get

Show project details.

kamui projects get <project-id>

Arguments:

Example output:

Project: my-project
ID:      5f809f2f-0787-40ca-9a43-a3a59edb5400
Plan:    free
Region:  tokyo
Created: 2025-01-15 10:30:00
Updated: 2025-01-20 14:22:00

Apps:
  ID                                    NAME      TYPE     URL
  a1b2c3d4-...                          api       dynamic  https://api-xxx.kamui.run

Databases:
  ID                                    NAME    TYPE      STATUS
  i9j0k1l2-...                          main-db postgres  running

kamui projects create

Create a project interactively.

kamui projects create

Interactive prompts:

1. Project name
2. Description (optional)
3. Plan type - Free or Pro
4. Region - Tokyo

Example:

? Project name: my-new-project
? Description (optional, max 80 chars): My awesome project
? Plan type: Free
? Region: Tokyo

Creating project...

✓ Project "my-new-project" created successfully!
  Plan:   free
  Region: tokyo

kamui projects delete

Delete a project.

kamui projects delete <project-name-or-id>

Arguments:

Options:

Examples:

# With confirmation
kamui projects delete my-project

# Without confirmation (for scripts)
kamui projects delete my-project --yes

⚠️ All resources in the project will be deleted.

Applications

kamui apps list

List apps in a project.

kamui apps list --project <project-name-or-id>
kamui apps list -p <project-name-or-id>

Options:

Example output:

Apps in project "my-project" (5f809f2f-0787-40ca-9a43-a3a59edb5400):

  • api-server
    ID: a1b2c3d4-5678-90ab-cdef-123456789abc
    Status: running
    URL: https://api-xxx.kamui.run

  • worker
    ID: e5f6g7h8-9012-34cd-ef56-789012345def
    Status: running

kamui apps create

Create an application interactively.

kamui apps create
kamui apps create --project my-project

Options:

Interactive prompts:

1. Select project
2. App type - Dynamic app / Static app (GitHub) / Static app (ZIP upload)
3. App name

For Dynamic app:

1. Language - Node.js / Go / Python
2. Deploy from - GitHub repository / Docker Hub
3. Select repository
4. Select branch
5. Directory (for monorepos)
6. Start command
7. Setup command
8. Pre-deploy command
9. Health check endpoint
10. Replicas
11. Add environment variables?
12. Connect to database?

For Static app (GitHub):

1. Select repository
2. Select branch
3. Directory (public directory)
4. App spec (resource size)
5. Replicas

For Static app (ZIP upload):

1. Path to directory or ZIP file
2. App spec (resource size)
3. Replicas

kamui apps delete

Delete an application.

kamui apps delete <app-name-or-id>

Arguments:

Options:

Examples:

kamui apps delete my-api
kamui apps delete my-api --yes

Output Formats

Text (Default)

Human-readable table format.

kamui projects list

JSON

JSON format suitable for scripting.

kamui projects list -o json

Using with jq:

# Get first project ID
PROJECT_ID=$(kamui projects list -o json | jq -r '.[0].id')
echo "Project ID: $PROJECT_ID"

# Show only Free plan projects
kamui projects list -o json | jq '.[] | select(.plan_type == "free")'

Configuration File

Credentials are stored at:

~/.kamui/config.json

This file contains OAuth tokens, so keep it secure.

Exit Codes

Example usage in scripts:

if kamui projects list > /dev/null 2>&1; then
  echo "Logged in"
else
  echo "Not logged in"
  kamui login
fi

Next Steps

• Installation
• Quick Start