kadai

name	kadai
description	kadai is a script runner for this project. Discover available actions with kadai list --json, and run them with kadai run <action-id>.
user-invocable	false

kadai — Project Script Runner

kadai manages and runs project-specific shell scripts stored in .kadai/actions/.

Discovering Actions

kadai list --json

Returns a JSON array of available actions:

[
  {
    "id": "database/reset",
    "name": "Reset Database",
    "emoji": "🗑️",
    "description": "Drop and recreate the dev database",
    "category": ["database"],
    "runtime": "bash",
    "confirm": true
  }
]

Use --all to include hidden actions: kadai list --json --all

Always use kadai list --json for the current set of actions — do not hardcode action lists.

Running Actions

kadai run <action-id>

Runs the action and streams stdout/stderr directly. The process exits with the action's exit code. Confirmation prompts are automatically skipped in non-TTY environments.

Examples

kadai run hello
kadai run database/reset

Creating Actions

Create a script file in .kadai/actions/. Supported extensions: .sh, .bash, .ts, .js, .mjs, .py, .tsx.

Add metadata as comments in the first 20 lines using # kadai:<key> <value> (for shell/python) or // kadai:<key> <value> (for JS/TS):

#!/bin/bash
# kadai:name Deploy Staging
# kadai:emoji 🚀
# kadai:description Deploy the app to the staging environment
# kadai:confirm true

echo "Deploying..."

Available metadata keys:

Key	Description
name	Display name in menus
emoji	Emoji prefix
description	Short description
confirm	Require confirmation before running (true/false)
hidden	Hide from default listing (true/false)
fullscreen	Use alternate screen buffer for ink actions (true/false)

If name is omitted, it is inferred from the filename (e.g. deploy-staging.sh → "Deploy Staging").

Organize actions into categories using subdirectories:

.kadai/actions/
  hello.sh              → id: "hello"
  database/
    migrate.sh          → id: "database/migrate"
    reset.ts            → id: "database/reset"