Skip to main content

AI-native cron task runner for per-project scheduled prompts and commands.

Project description

kage 影 - AI Native Cron Task Runner

kage hero

English | 日本語

kage is a tool for running scheduled tasks using AI CLIs (codex, claude, gemini, etc.) or standard shell commands, managed on a per-project basis.

Features

  • AI Native: Run AI prompts directly from a cron schedule.
  • Flexible AI Providers: Built-in support for codex, claude, gemini, and copilot with easy customization.
  • Inline Overrides: Customize commands, AI models, or parsers (like jq) for each specific task.
  • 3-Layer Configuration: Configuration is merged from library defaults, user overrides (~/.kage), and workspace-specific settings (.kage).
  • Web UI: Monitor task execution and logs through a sleek browser dashboard.

Installation

The easiest way to install kage is via the interactive installer:

curl -sSL https://raw.githubusercontent.com/igtm/kage/main/install.sh | bash

Or install from PyPI:

pip install kage-ai

Alternatively, install with uv:

uv tool install git+https://github.com/igtm/kage.git
kage onboard

Getting Started

  1. Global Setup (First time only):

    kage onboard
    

    This initializes ~/.kage/, the database, and the crontab entries.

  2. Configure AI Engine: Create ~/.kage/config.toml and specify your default engine.

    default_ai_engine = "codex"
    
  3. Initialize Project: Run this in your project directory.

    kage init
    

    This creates .kage/tasks/sample.toml.

Task Definition Samples

Define tasks in .toml or .md files under .kage/tasks/.

  • *.toml: existing format (single or multiple tasks per file)
  • *.md: front matter + markdown body, one file = one prompt task only
# Auto-refactor using AI
[task_refactor]
name = "Daily Refactor"
cron = "0 3 * * *"
prompt = "Please clean up the code in src/"
provider = "claude"

# Classification with JSON/JQ parsing
[task_labels]
name = "Ticket Labeling"
cron = "*/30 * * * *"
prompt = "Classify this issue as JSON '{\"label\":\"...\"}': 'Cannot login'"
provider = "codex_json"
parser_args = ".label"

# Standard Shell Command
[task_cleanup]
name = "Log Cleanup"
cron = "0 0 * * 0"
command = "rm -rf ./logs/*.log"
shell = "bash"
---
name: Nightly Research
cron: "0 2 * * *"
provider: codex
---

Collect benchmark updates and summarize differences.
Add comparison points for quality, speed, and cost.

In markdown tasks, the entire body after front matter is treated as the prompt.

Commands

  • kage onboard: Initialize global settings and OS-level daemon.
  • kage init: Initialize current directory as a kage project.
  • kage daemon install: Register kage to system scheduler (cron/launchd).
  • kage daemon remove: Unregister kage from system scheduler.
  • kage daemon status: Check daemon registration status.
  • kage config <key> <value> [--global]: Update configuration via CLI.
  • kage doctor: Check setup health and configuration.
  • kage ui: Launch web dashboard (default: http://localhost:8484).
  • kage logs: View execution history.
  • kage run: Force run all scheduled tasks (normally executed by cron/launchd).
  • kage task list: List all tasks across all registered projects.
  • kage task show <name>: Show details for one task.
  • kage task run <name>: Run one task immediately.
  • kage project list: List registered projects.
  • kage project remove [path]: Unregister a project.

Release / Publish

# 1) Build package
uv build

# 2) Create release (example: v0.0.1)
gh release create v0.0.1 --title "kage v0.0.1" --generate-notes

# 3) Publish to PyPI (token auth)
TWINE_USERNAME=__token__ \
TWINE_PASSWORD='<pypi-token>' \
uvx twine upload dist/*

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kage_ai-0.0.7.tar.gz (1.9 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kage_ai-0.0.7-py3-none-any.whl (29.2 kB view details)

Uploaded Python 3

File details

Details for the file kage_ai-0.0.7.tar.gz.

File metadata

  • Download URL: kage_ai-0.0.7.tar.gz
  • Upload date:
  • Size: 1.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.6

File hashes

Hashes for kage_ai-0.0.7.tar.gz
Algorithm Hash digest
SHA256 689bfabaa8d41ae3a9839bdd1b47eb31f5f5976453c900ba37f97786a1d7da1a
MD5 2aad6ff542fd3e81ecd074810acea6dd
BLAKE2b-256 8d7fa8fbd275b8a1fc4ae297666c352faadadda96d5ecdcc3a1916b1923f2505

See more details on using hashes here.

File details

Details for the file kage_ai-0.0.7-py3-none-any.whl.

File metadata

  • Download URL: kage_ai-0.0.7-py3-none-any.whl
  • Upload date:
  • Size: 29.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.6

File hashes

Hashes for kage_ai-0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 4d9b797afd9485023f8fcfdacb56cce7e80d4b3870d135893cc40aa04ad5f44e
MD5 16a247069e7fbadd66d7e5ec10582f1d
BLAKE2b-256 58905899d1d60f18d5f4852920368ff3ed43bafa2d07527e4eb26a53c9c2de9b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page