@atollhq/skill-codex 0.1.3 → 0.1.5
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 +47 -0
- package/package.json +1 -1
- package/skill/SKILL.md +31 -9
package/README.md
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# @atollhq/skill-codex
|
|
2
|
+
|
|
3
|
+
Install the [Atoll](https://atollhq.com) project management integration for [Codex CLI](https://github.com/openai/codex).
|
|
4
|
+
|
|
5
|
+
Gives your Codex agent the ability to manage tasks, goals, KPIs, initiatives, milestones, comments, and webhooks on Atoll — the same API surface a human teammate uses.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npx @atollhq/skill-codex --key sk_atoll_... --org your-org-slug
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Get an API key from **Settings > Members > Add Agent** (or **Create API Key** for integrations) in the Atoll app.
|
|
14
|
+
|
|
15
|
+
This does three things:
|
|
16
|
+
|
|
17
|
+
1. Appends (or updates) an `# Atoll Integration` section in `~/.codex/AGENTS.md`
|
|
18
|
+
2. Copies API reference files to `~/.codex/atoll-references/`
|
|
19
|
+
3. Appends `ATOLL_API_KEY` and `ATOLL_ORG_SLUG` exports to your shell profile (`~/.zshrc` or `~/.bashrc`)
|
|
20
|
+
|
|
21
|
+
Open a fresh shell (or `source` your profile) and Codex has the Atoll integration.
|
|
22
|
+
|
|
23
|
+
## Using the integration
|
|
24
|
+
|
|
25
|
+
Once installed, ask Codex anything task-related:
|
|
26
|
+
|
|
27
|
+
```
|
|
28
|
+
"List my Atoll tasks"
|
|
29
|
+
"Create an issue to fix the login bug, priority 1"
|
|
30
|
+
"What goals are off pace?"
|
|
31
|
+
"Move ATOLL-42 to in_progress"
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Companion CLI
|
|
35
|
+
|
|
36
|
+
For terminal-first work, see [`@atollhq/cli`](https://www.npmjs.com/package/@atollhq/cli):
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
npm install -g @atollhq/cli
|
|
40
|
+
atoll auth login --key sk_atoll_...
|
|
41
|
+
atoll config set-org your-org-slug
|
|
42
|
+
atoll issue list
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## License
|
|
46
|
+
|
|
47
|
+
MIT
|
package/package.json
CHANGED
package/skill/SKILL.md
CHANGED
|
@@ -26,16 +26,31 @@ Agents are org members with the same API, same permissions, same ability to crea
|
|
|
26
26
|
|
|
27
27
|
All requests require: `Authorization: Bearer sk_atoll_<key>`
|
|
28
28
|
|
|
29
|
-
|
|
29
|
+
API keys are generated in **Settings > Members > Add Agent** (for agents) or **Settings > Members > Create API Key** (for integrations). Each key is scoped to one org. Store both values as env vars:
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
```bash
|
|
32
|
+
export ATOLL_API_KEY="sk_atoll_..."
|
|
33
|
+
export ATOLL_ORG_ID="..." # UUID of the org the key belongs to
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
**Sanity check** — exercises the org-scoped issues endpoint, not just `/api/auth/me`:
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
: "${ATOLL_API_KEY:?missing}" "${ATOLL_ORG_ID:?missing}" && \
|
|
40
|
+
curl -sS -o /dev/null -w "HTTP:%{http_code}\n" \
|
|
41
|
+
"https://atollhq.com/api/orgs/$ATOLL_ORG_ID/issues?limit=1" \
|
|
42
|
+
-H "Authorization: Bearer $ATOLL_API_KEY"
|
|
43
|
+
# Expect: HTTP:200
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
If `$ATOLL_ORG_ID` is empty, the URL collapses to `/api/orgs//issues` which 308-redirects to a non-existent route and returns `Unauthorized` — a misleading symptom that looks like an auth failure. `GET /api/auth/me` alone cannot catch this since it doesn't depend on `$ATOLL_ORG_ID`. Always guard both vars.
|
|
32
47
|
|
|
33
48
|
## Quick Start — CLI (recommended)
|
|
34
49
|
|
|
35
50
|
Install globally or use via npx:
|
|
36
51
|
|
|
37
52
|
```bash
|
|
38
|
-
npm install -g @atollhq/cli # or: npx
|
|
53
|
+
npm install -g @atollhq/cli # or: npx @atollhq/cli ...
|
|
39
54
|
```
|
|
40
55
|
|
|
41
56
|
Configure once:
|
|
@@ -78,11 +93,16 @@ atoll milestone list --project <project-id>
|
|
|
78
93
|
All CLI commands map to REST endpoints. Use the API directly when the CLI doesn't cover a specific operation.
|
|
79
94
|
|
|
80
95
|
```bash
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
96
|
+
# Prereq: both env vars exported (see Authentication above)
|
|
97
|
+
atoll() {
|
|
98
|
+
: "${ATOLL_API_KEY:?ATOLL_API_KEY not set}"
|
|
99
|
+
: "${ATOLL_ORG_ID:?ATOLL_ORG_ID not set}"
|
|
100
|
+
curl -s -H "Authorization: Bearer $ATOLL_API_KEY" \
|
|
101
|
+
-H "Content-Type: application/json" \
|
|
102
|
+
"https://atollhq.com$1" "${@:2}"
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
atoll "/api/orgs/$ATOLL_ORG_ID/issues?status=todo"
|
|
86
106
|
```
|
|
87
107
|
|
|
88
108
|
## The Heartbeat Loop
|
|
@@ -142,7 +162,7 @@ Full endpoint tables and field schemas:
|
|
|
142
162
|
|----------|--------|------|--------|--------|
|
|
143
163
|
| Orgs | POST `/api/orgs` | GET `/api/orgs` | PATCH `/api/orgs/{id}` | DELETE `/api/orgs/{id}` |
|
|
144
164
|
| Projects | POST `.../projects` | GET `.../projects` | PATCH `.../projects/{id}` | DELETE `.../projects/{id}` |
|
|
145
|
-
| Tasks | POST `.../issues` | GET `.../issues` | PATCH `.../issues/{id}` | DELETE `.../issues/{id}` |
|
|
165
|
+
| Tasks | POST `.../issues` | GET `.../issues` | PATCH `.../issues/{id}` | DELETE `.../issues/{id}` † |
|
|
146
166
|
| Goals | POST `.../goals` | GET `.../goals` | PATCH `.../goals/{id}` | DELETE `.../goals/{id}` |
|
|
147
167
|
| KPIs | POST `.../kpis` | GET `.../kpis` | PATCH `.../kpis/{id}` | DELETE `.../kpis/{id}` |
|
|
148
168
|
| Initiatives | POST `.../initiatives` | GET `.../initiatives` | PATCH `.../initiatives/{id}` | DELETE `.../initiatives/{id}` |
|
|
@@ -152,6 +172,8 @@ Full endpoint tables and field schemas:
|
|
|
152
172
|
|
|
153
173
|
All endpoints are under `/api/orgs/{orgId}/...`.
|
|
154
174
|
|
|
175
|
+
† `DELETE /issues/{id}` requires `owner` or `admin` role — any caller without that role (including member-role agents) gets `403`. If you just need to remove a task, use `POST /api/orgs/{orgId}/issues/{issueId}/archive` (soft delete, no role gate); reverse with `DELETE` on the same path (unarchive).
|
|
176
|
+
|
|
155
177
|
### Quick enum reference
|
|
156
178
|
|
|
157
179
|
- **Task status**: `backlog`, `todo`, `in_progress`, `done`, `cancelled` (custom per project)
|