@atollhq/skill-codex 0.1.1 → 0.1.3
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/package.json +1 -1
- package/skill/SKILL.md +73 -19
- package/skill/references/api-endpoints.md +9 -0
package/package.json
CHANGED
package/skill/SKILL.md
CHANGED
|
@@ -30,32 +30,59 @@ Verify with: `GET /api/auth/me`
|
|
|
30
30
|
|
|
31
31
|
API keys are generated in **Settings > Members > Add Agent** (for agents) or **Settings > Members > Create API Key** (for integrations). Store as `$ATOLL_API_KEY`.
|
|
32
32
|
|
|
33
|
-
## Quick Start
|
|
33
|
+
## Quick Start — CLI (recommended)
|
|
34
|
+
|
|
35
|
+
Install globally or use via npx:
|
|
34
36
|
|
|
35
37
|
```bash
|
|
36
|
-
|
|
38
|
+
npm install -g @atollhq/cli # or: npx atoll ...
|
|
39
|
+
```
|
|
37
40
|
|
|
38
|
-
|
|
39
|
-
atoll() {
|
|
40
|
-
curl -s -H "Authorization: Bearer $ATOLL_API_KEY" \
|
|
41
|
-
-H "Content-Type: application/json" \
|
|
42
|
-
"https://atollhq.com$1" "${@:2}" | python3 -m json.tool
|
|
43
|
-
}
|
|
41
|
+
Configure once:
|
|
44
42
|
|
|
45
|
-
|
|
46
|
-
atoll
|
|
43
|
+
```bash
|
|
44
|
+
atoll auth login --key sk_atoll_...
|
|
45
|
+
atoll config set-org my-org
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Common commands:
|
|
47
49
|
|
|
50
|
+
```bash
|
|
48
51
|
# List tasks
|
|
49
|
-
atoll
|
|
52
|
+
atoll issue list
|
|
53
|
+
atoll issue list --status todo --priority 1
|
|
54
|
+
|
|
55
|
+
# View a task
|
|
56
|
+
atoll issue view ATOLL-42
|
|
50
57
|
|
|
51
58
|
# Create a task
|
|
52
|
-
atoll
|
|
59
|
+
atoll issue create --title "Fix login bug" --status todo --priority 1
|
|
53
60
|
|
|
54
61
|
# Update a task
|
|
55
|
-
atoll
|
|
62
|
+
atoll issue update ATOLL-42 --status in_progress
|
|
63
|
+
|
|
64
|
+
# Assign a task
|
|
65
|
+
atoll issue assign ATOLL-42 --to <user-id>
|
|
66
|
+
atoll issue assign ATOLL-42 --to self
|
|
67
|
+
|
|
68
|
+
# Comments
|
|
69
|
+
atoll comment add ATOLL-42 --body "Working on this now"
|
|
70
|
+
|
|
71
|
+
# Projects & milestones
|
|
72
|
+
atoll project list
|
|
73
|
+
atoll milestone list --project <project-id>
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
## Quick Start — API (for advanced use)
|
|
56
77
|
|
|
57
|
-
|
|
58
|
-
|
|
78
|
+
All CLI commands map to REST endpoints. Use the API directly when the CLI doesn't cover a specific operation.
|
|
79
|
+
|
|
80
|
+
```bash
|
|
81
|
+
export ATOLL_API_KEY="sk_atoll_..."
|
|
82
|
+
|
|
83
|
+
curl -s -H "Authorization: Bearer $ATOLL_API_KEY" \
|
|
84
|
+
-H "Content-Type: application/json" \
|
|
85
|
+
"https://atollhq.com/api/orgs/{orgId}/issues?status=todo"
|
|
59
86
|
```
|
|
60
87
|
|
|
61
88
|
## The Heartbeat Loop
|
|
@@ -81,10 +108,12 @@ Signal types: `kpi_off_pace`, `kpi_stale`, `issue_stale`, `issue_blocked`, `mile
|
|
|
81
108
|
|
|
82
109
|
### Pick up and complete a task
|
|
83
110
|
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
111
|
+
```bash
|
|
112
|
+
atoll issue list --status todo --assignee self # find assigned work
|
|
113
|
+
atoll issue update ATOLL-42 --status in_progress # start work
|
|
114
|
+
atoll comment add ATOLL-42 --body "Progress update…" # report progress
|
|
115
|
+
atoll issue update ATOLL-42 --status done # complete
|
|
116
|
+
```
|
|
88
117
|
|
|
89
118
|
### Set up the strategy chain
|
|
90
119
|
|
|
@@ -132,6 +161,31 @@ All endpoints are under `/api/orgs/{orgId}/...`.
|
|
|
132
161
|
- **KPI direction**: `increase`, `decrease`, `maintain`
|
|
133
162
|
- **Member role**: `owner`, `admin`, `member`, `guest`
|
|
134
163
|
|
|
164
|
+
## Platform Feedback
|
|
165
|
+
|
|
166
|
+
Report bugs or request features for the Atoll platform itself. This sends feedback to the Atoll team's internal board — not to your org.
|
|
167
|
+
|
|
168
|
+
```bash
|
|
169
|
+
curl -X POST https://atollhq.com/api/feedback \
|
|
170
|
+
-H "Content-Type: application/json" \
|
|
171
|
+
-d '{
|
|
172
|
+
"type": "bug",
|
|
173
|
+
"description": "The /issues endpoint returns 500 when filtering by milestoneId and status together",
|
|
174
|
+
"userEmail": "agent@example.com",
|
|
175
|
+
"userName": "My Agent"
|
|
176
|
+
}'
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
| Field | Required | Description |
|
|
180
|
+
|-------|----------|-------------|
|
|
181
|
+
| `type` | No | `bug` (default) or `feature` |
|
|
182
|
+
| `description` | Yes | What went wrong or what you'd like to see |
|
|
183
|
+
| `userEmail` | No | Reporter email for follow-up |
|
|
184
|
+
| `userName` | No | Reporter display name |
|
|
185
|
+
| `url` | No | Page or endpoint URL where the issue occurred |
|
|
186
|
+
|
|
187
|
+
No authentication required. Use this when you encounter unexpected API errors, missing functionality, or have suggestions for the platform.
|
|
188
|
+
|
|
135
189
|
## Notes
|
|
136
190
|
|
|
137
191
|
- Request bodies accept camelCase; responses use snake_case
|
|
@@ -40,6 +40,7 @@ All endpoints require `Authorization: Bearer sk_atoll_...` header.
|
|
|
40
40
|
- [Agents](#agents)
|
|
41
41
|
- [Integrations](#integrations)
|
|
42
42
|
- [GitHub Integration](#github-integration)
|
|
43
|
+
- [Platform Feedback](#platform-feedback)
|
|
43
44
|
|
|
44
45
|
---
|
|
45
46
|
|
|
@@ -397,3 +398,11 @@ URL must be HTTPS. Returns webhook record plus `secret` for HMAC verification.
|
|
|
397
398
|
| GET | `/api/integrations/github/repos` | List available repos |
|
|
398
399
|
| POST | `/api/integrations/github/connect` | Connect a repo |
|
|
399
400
|
| POST | `/api/integrations/github/disconnect` | Disconnect a repo |
|
|
401
|
+
|
|
402
|
+
## Platform Feedback
|
|
403
|
+
|
|
404
|
+
No authentication required. Sends feedback to the Atoll team's internal board.
|
|
405
|
+
|
|
406
|
+
| Method | Endpoint | Description |
|
|
407
|
+
|--------|----------|-------------|
|
|
408
|
+
| POST | `/api/feedback` | Submit bug report or feature request (`{ type, description, userEmail?, userName?, url? }`)
|