@atollhq/cli 0.1.2 → 0.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +84 -0
- package/dist/index.js +652 -56
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -43,6 +43,7 @@ Each profile can store its own API key, default org, default team, and base URL.
|
|
|
43
43
|
|
|
44
44
|
```bash
|
|
45
45
|
atoll issue list
|
|
46
|
+
atoll heartbeat
|
|
46
47
|
atoll issue create --title "Fix login bug" --priority 1
|
|
47
48
|
atoll issue view ATOLL-42
|
|
48
49
|
atoll project list
|
|
@@ -64,6 +65,89 @@ atoll --team eng issue create --title "..."
|
|
|
64
65
|
|
|
65
66
|
Or via env vars: `ATOLL_PROFILE`, `ATOLL_API_KEY`, `ATOLL_ORG`, `ATOLL_TEAM`, `ATOLL_BASE_URL`.
|
|
66
67
|
|
|
68
|
+
## Agent-friendly output
|
|
69
|
+
|
|
70
|
+
Use `--json` on any command to emit machine-readable output:
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
atoll --json issue list
|
|
74
|
+
atoll heartbeat --json
|
|
75
|
+
atoll agent-context
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
List commands return a bounded object:
|
|
79
|
+
|
|
80
|
+
```json
|
|
81
|
+
{
|
|
82
|
+
"resource": "issues",
|
|
83
|
+
"items": [],
|
|
84
|
+
"total": 0,
|
|
85
|
+
"limit": 25,
|
|
86
|
+
"offset": 0,
|
|
87
|
+
"nextOffset": null,
|
|
88
|
+
"truncated": false,
|
|
89
|
+
"hint": null
|
|
90
|
+
}
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
Diagnostics and errors are written to stderr.
|
|
94
|
+
|
|
95
|
+
## Heartbeat
|
|
96
|
+
|
|
97
|
+
Heartbeat is the primary agent orientation command:
|
|
98
|
+
|
|
99
|
+
```bash
|
|
100
|
+
atoll heartbeat
|
|
101
|
+
atoll heartbeat --signals-only
|
|
102
|
+
atoll heartbeat --severity critical
|
|
103
|
+
atoll heartbeat --json
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
It wraps `GET /api/orgs/{orgId}/heartbeat` and returns active goals, KPI pace, initiative health, assigned work, and prioritized signals.
|
|
107
|
+
|
|
108
|
+
## Agent context
|
|
109
|
+
|
|
110
|
+
`atoll agent-context` emits a versioned JSON description of the CLI surface, selected profile/org context, known command flags, enum values, and available Atoll skill manifests.
|
|
111
|
+
|
|
112
|
+
```bash
|
|
113
|
+
atoll agent-context | jq '.schema_version, .commands.heartbeat'
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
## Safer deletion
|
|
117
|
+
|
|
118
|
+
Permanent delete commands require `--force` and support `--dry-run`:
|
|
119
|
+
|
|
120
|
+
```bash
|
|
121
|
+
atoll issue delete ATOLL-42 --dry-run
|
|
122
|
+
atoll issue delete ATOLL-42 --force
|
|
123
|
+
atoll comment delete <comment-id> --issue ATOLL-42 --force
|
|
124
|
+
atoll webhook delete <id> --force
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
For issues, prefer reversible archive:
|
|
128
|
+
|
|
129
|
+
```bash
|
|
130
|
+
atoll issue archive ATOLL-42
|
|
131
|
+
atoll issue unarchive ATOLL-42
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
## Feedback
|
|
135
|
+
|
|
136
|
+
Record CLI or platform friction locally:
|
|
137
|
+
|
|
138
|
+
```bash
|
|
139
|
+
atoll feedback "the --status error should list custom board statuses"
|
|
140
|
+
atoll feedback list
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
Submit upstream as well:
|
|
144
|
+
|
|
145
|
+
```bash
|
|
146
|
+
atoll feedback --send "heartbeat should include issue_blocked signals"
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
Set `ATOLL_FEEDBACK_ENDPOINT` to override the destination.
|
|
150
|
+
|
|
67
151
|
## Output URLs
|
|
68
152
|
|
|
69
153
|
Issue and project JSON output includes a canonical `url` field pointing at the Atoll web app (honoring `ATOLL_BASE_URL` for self-hosted / local dev), suitable for pasting into standups, notifications, and follow-ups:
|