diff options
Diffstat (limited to 'makima/src/daemon/skills/contract.md')
| -rw-r--r-- | makima/src/daemon/skills/contract.md | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/makima/src/daemon/skills/contract.md b/makima/src/daemon/skills/contract.md new file mode 100644 index 0000000..51bc0f1 --- /dev/null +++ b/makima/src/daemon/skills/contract.md @@ -0,0 +1,100 @@ +--- +name: makima-contract +description: Contract commands for makima task-contract interaction. Use when checking contract status, reading goals, reporting progress, or managing contract files. +--- + +# Makima Contract Commands + +These commands let tasks interact with their contract context. Environment variables (`MAKIMA_API_URL`, `MAKIMA_API_KEY`, `MAKIMA_CONTRACT_ID`, `MAKIMA_TASK_ID`) are pre-configured by the daemon. + +## Status and Information + +### Get contract status +```bash +makima contract status +``` +Returns current phase, progress, and task summary. + +### Get phase checklist +```bash +makima contract checklist +``` +Returns checklist items for current phase. + +### Get contract goals +```bash +makima contract goals +``` +Returns the goals and success criteria for the contract. + +### Get suggested next action +```bash +makima contract suggest-action +``` +Returns AI-suggested next step based on current state. + +### Get completion recommendation +```bash +makima contract completion-action --code --files "file1.ts,file2.ts" --lines-added 50 --lines-removed 10 +``` +Get recommendation for what to do after completing work. + +Options: +- `--code` - Indicates there are code changes +- `--files "<comma-separated>"` - List of modified files +- `--lines-added <n>` - Number of lines added +- `--lines-removed <n>` - Number of lines removed + +## Contract Files + +Contract files are shared documents (plans, specs, notes) managed by the contract. + +### List contract files +```bash +makima contract files +``` + +### Get file content +```bash +makima contract file <file_id> +``` + +### Update file content +```bash +echo "New content" | makima contract update-file <file_id> +``` +Reads content from stdin. + +### Create new file +```bash +echo "File content" | makima contract create-file "<filename>" +``` +Reads content from stdin. + +## Progress Reporting + +### Report progress +```bash +makima contract report "<progress_message>" +``` +Reports progress visible to supervisor and user. + +## Output Format + +All commands output JSON to stdout. + +Example workflow: +```bash +# Check current phase and goals +makima contract status +makima contract goals + +# Check what needs to be done +makima contract checklist + +# Report progress +makima contract report "Completed initial analysis" + +# Get next recommended action +makima contract suggest-action +``` |
