@cyanautomation/kaseki-agent
v1.126.0
Published
Admin/helper/doctor toolbox and local API client for Kaseki diagnostics, setup, and API-backed coding-agent task workflows
Maintainers
Readme
Kaseki Agent
Kaseki is a proof-of-concept ephemeral coding-agent runner. Each run creates a numbered, disposable container instance (kaseki-1, kaseki-2, etc.) that orchestrates the Pi coding-agent via a generic LLM gateway (Manifest, OpenAI, Ollama, etc.).
Quick Start
1. Install Setup
# Global install (recommended)
npm install -g @cyanautomation/kaseki-agent
# One-command setup with auto-detection
kaseki-agent initOr use Docker:
docker run -it docker.io/cyanautomation/kaseki-agent:latest init2. Configure Authentication
The setup wizard will guide you through providing:
- LLM Gateway URL (required): Your LLM provider endpoint (e.g.,
https://llmgateway.local.xyz/v1/responses) - LLM Gateway API Key (required): Authentication token for your provider
- GitHub App Credentials (optional): App ID, Client ID, Private Key
CloudFlare Gateway Live Probe
The Jest suite uses deterministic unit/contract coverage for CloudFlare gateway behavior and mocks fetch; it does not perform live network calls or consume gateway tokens. To run the live CloudFlare probe explicitly, use:
CLOUDFLARE_GATEWAY_TEST=1 \
LLM_GATEWAY_URL=https://gateway.ai.cloudflare.com/v1/<account>/<gateway>/compat \
LLM_GATEWAY_API_KEY=<token> \
npm run test:integration:cloudflare-gatewayThe live probe requires CLOUDFLARE_GATEWAY_TEST=1, a configured LLM_GATEWAY_URL, either LLM_GATEWAY_API_KEY or LLM_GATEWAY_API_KEY_FILE, and working token/network access to CloudFlare. LLM_GATEWAY_MODEL is optional and defaults to dynamic/kaseki-agent.
3. Run Your First Task
# Start API service (Docker Compose recommended)
docker-compose up -d
# Submit a task
kaseki-agent run https://github.com/CyanAutomation/crudmapper main \
"Add input validation to all POST endpoints"4. Monitor Results
# List all instances
kaseki-agent list
# Get detailed report
kaseki-agent report kaseki-1
# Live monitoring
kaseki-agent status kaseki-15. Run API Locally
# Start local API on port 8080
kaseki-agent serve --port 8080 &
# Health check (no auth required)
curl http://localhost:8080/health
# Authenticated endpoint
KASEKI_API_KEYS=sk-local-secret \
curl -H "Authorization: Bearer sk-local-secret" \
http://localhost:8080/api/preflight
# Override default URL
KASEKI_API_URL=http://localhost:9090 kaseki-agent serve --port 9090Overview
Kaseki provides three deployment patterns:
- NPM CLI: Admin/helper workflows and task clients
- Docker: Containerized execution without host Node.js
- REST API: Local/distributed orchestration via
kaseki-agent serve
Each task execution produces isolated workspace and results for reproducible AI coding workflows.
Development
- Node.js >= 24 required
- Install dependencies:
npm ci - Run validation:
npm run check
Installation
Global NPM (Recommended)
npm install -g @cyanautomation/kaseki-agentLocal NPM
npm install @cyanautomation/kaseki-agent
npx kaseki-agent initDocker
docker run -it docker.io/cyanautomation/kaseki-agent:latest initBasic Usage
CLI Commands
kaseki-agent init- Interactive setup wizardkaseki-agent doctor- Health check and diagnosticskaseki-agent run [repo] [ref] [prompt]- Execute coding taskkaseki-agent list- List all instanceskaseki-agent report [instance]- Detailed resultskaseki-agent status [instance]- Live status monitoringkaseki-agent serve- Start local API service
Task Execution
# Basic task
kaseki-agent run https://github.com/owner/repo main "Fix TypeScript errors"
# With custom API URL
KASEKI_API_URL=http://localhost:8080/api \
kaseki-agent run https://github.com/owner/repo main "Add unit tests"
# Monitor progress
kaseki-agent status kaseki-1 --followConfiguration
Authentication
- Config file (recommended):
~/.kaseki/config.json - Environment variables:
LLM_GATEWAY_API_KEY_FILE,GITHUB_APP_*_FILE - Docker secrets: Mount
/secretsvolume
Environment Variables
See docs/ENV_VARS.md for complete configuration reference.
Deployment Options
- Docker Compose: Production deployment with persistent API
- Single-run: Ephemeral execution for CI/CD
- Local API: Development and testing
API Reference
REST API
Start local API service:
kaseki-agent serve --port 8080Kaseki Task Console
Web UI served at /ui (and /) by kaseki-agent serve. Use it to monitor health, browse GitHub issues, and submit tasks.
Base URL: http://<host>:<port>/ui (default http://localhost:8080/ui).
Override host/port with KASEKI_API_URL env var (e.g., KASEKI_API_URL=http://localhost:9090).
Authentication: Bearer token. Enter token in the header input field or set KASEKI_API_KEY env var. Requests to authenticated endpoints include Authorization: Bearer <token>.
Server validates tokens listed in KASEKI_API_KEYS config (comma-separated).
Usage examples:
# Health check (no auth required)
curl http://localhost:8080/health
# Health check with bearer token
curl -H "Authorization: Bearer sk-kaseki-..." http://localhost:8080/api/preflight
# Submit a task run via the API
curl -X POST http://localhost:8080/api/run \
-H "Authorization: Bearer sk-kaseki-..." \
-H "Content-Type: application/json" \
-d '{
"repo": "https://github.com/org/repo",
"ref": "main",
"prompt": "Fix the failing test"
}'
# Access the Task Console in browser
open http://localhost:8080/uiTabs:
- Health — Preflight checks and recent run status
- Issues — Browse GitHub issues
- Submit Task — Submit a coding task with repo, ref, and prompt
Swagger API documentation available at /docs.
Programmatic Usage
- Live monitoring: Query running instances
- Error detection: Identify failures and anomalies
- Post-run analysis: Detailed result summaries
- Log streaming: Real-time log consumption
- Automatic review requests: PRs on personal repositories automatically request the owner as a reviewer
See docs/API.md and docs/CLI.md for complete API and CLI documentation.
Architecture
Kaseki orchestrates ephemeral coding-agent instances with:
- Host layer: Workspace management, credential resolution, Docker runtime
- Container layer: Git cloning, dependency caching, Pi agent invocation
- Result layer: Artifact collection, validation gates, quality metrics
- API layer: REST service for external orchestration
Each run produces isolated workspace with:
- Repository clone at target ref
- Node.js dependency cache
- Pi agent execution
- Validation and quality gates
- Comprehensive result artifacts
Resources
Documentation
- Quick Start Guide - Step-by-step setup
- CLI Reference - Command-line monitoring tools
- API Documentation - REST API specification
- Deployment Guide - Production deployment
- Environment Variables - Configuration reference
- Advanced Configuration - Detailed setup options
- Troubleshooting - Common issues and solutions
Community
- Issues: GitHub Issues
- Discussions: GitHub Discussions
- Updates: Follow for releases and announcements
License
MIT License - see LICENSE for details.
CyanAutomation - Building reliable AI coding workflows
