@robbeverhelst/do 0.0.1
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 +44 -0
- package/dist/do.js +21948 -0
- package/package.json +41 -0
package/README.md
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# @do/cli
|
|
2
|
+
|
|
3
|
+
`do` — an agent-drivable command-line client over the **do** public API
|
|
4
|
+
(`/api/v1`). A thin HTTP client: per-tenant API-key auth, the same validation and
|
|
5
|
+
RLS wall as the web app, no direct database access.
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
bunx @do/cli help
|
|
9
|
+
bunx @do/cli today
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Scope (v1)
|
|
13
|
+
|
|
14
|
+
The daily loop, all over `/api/v1` with an API key — no destructive verbs:
|
|
15
|
+
|
|
16
|
+
- `capture "<text> #tag !priority"` — quick-add a task to the inbox
|
|
17
|
+
- `today` — actionable tasks (overdue / scheduled / due / in-progress)
|
|
18
|
+
- `task done <id>` — complete (idempotent)
|
|
19
|
+
- `task snooze <id> [--days N | --until <date>]` — reschedule
|
|
20
|
+
- `habit log <id> [--value N] [--at <iso>]` — record a check-in
|
|
21
|
+
- `<entity> list` / `<entity> get <id>` — read tasks, habits, occurrences,
|
|
22
|
+
shopping-lists, inventory-items, recipes, meal-plans, notes, contacts, webhooks
|
|
23
|
+
- `login`, `config`, `whoami`, `help`, `version`
|
|
24
|
+
|
|
25
|
+
## Auth & config
|
|
26
|
+
|
|
27
|
+
Resolution order: `--api-key`/`--url` flags → `DO_API_KEY`/`DO_API_URL` env →
|
|
28
|
+
`~/.config/do/config.json` (written by `do login` / `do config set`).
|
|
29
|
+
|
|
30
|
+
## Output
|
|
31
|
+
|
|
32
|
+
`--json` everywhere, and automatic JSON when stdout is piped (non-TTY). Failures
|
|
33
|
+
print `{ "error": { code, message } }` and exit non-zero (see `do help --json`).
|
|
34
|
+
|
|
35
|
+
## Develop
|
|
36
|
+
|
|
37
|
+
```sh
|
|
38
|
+
bun run --filter '@do/cli' dev -- today # run from source
|
|
39
|
+
bun run --filter '@do/cli' test # bun:test suite
|
|
40
|
+
bun run --filter '@do/cli' compile # standalone ./do binary
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
The full agent skill lives at [`docs/agents/do-cli.md`](../../docs/agents/do-cli.md);
|
|
44
|
+
the authoritative surface is always `do help --json`.
|