summaryrefslogtreecommitdiff
path: root/makima/src/daemon/skills/contract.md
blob: 51bc0f1c5f210aa3a6dd182644df5e4c7ade2b94 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
```