@hasna/platform-todos-cli 0.1.0
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 +61 -0
- package/bin/platform-todos.js +2613 -0
- package/package.json +35 -0
- package/tsconfig.json +8 -0
package/README.md
ADDED
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# platform-todos CLI
|
|
2
|
+
|
|
3
|
+
Remote-only paid CLI for `todos.md`.
|
|
4
|
+
|
|
5
|
+
The CLI talks to the hosted API at `https://todos.md` by default. It does not
|
|
6
|
+
ship or initialize the open-source local SQLite runtime.
|
|
7
|
+
|
|
8
|
+
```bash
|
|
9
|
+
platform-todos auth login --email you@example.com
|
|
10
|
+
platform-todos auth whoami
|
|
11
|
+
platform-todos api-keys create --name ci --scopes tasks:read,tasks:create --select
|
|
12
|
+
platform-todos billing checkout --plan pro --open
|
|
13
|
+
platform-todos organization members
|
|
14
|
+
platform-todos organization invite teammate@example.com --role member
|
|
15
|
+
platform-todos tasks list
|
|
16
|
+
platform-todos queue sync
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
For non-interactive environments, set `PLATFORM_TODOS_API_KEY`, pass `--api-key`,
|
|
20
|
+
or select a stored profile key with `platform-todos api-keys select --key <key>`.
|
|
21
|
+
Commands that store a key only print redacted key material.
|
|
22
|
+
|
|
23
|
+
## Help and Completions
|
|
24
|
+
|
|
25
|
+
This package is the paid hosted CLI. It is separate from the public local-first
|
|
26
|
+
`@hasna/todos` OSS package and does not read the local SQLite runtime unless you
|
|
27
|
+
explicitly submit an export manifest with `platform-todos import local-sqlite`.
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
platform-todos help
|
|
31
|
+
platform-todos help tasks
|
|
32
|
+
platform-todos manpage
|
|
33
|
+
platform-todos completion bash
|
|
34
|
+
platform-todos completion zsh
|
|
35
|
+
platform-todos completion fish
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Use `--json` for stable machine-readable stdout. Errors are written to stderr as
|
|
39
|
+
`{ error, status, body? }` when `--json` is set. Exit `0` means success; exit
|
|
40
|
+
`1` means usage, authentication, quota, conflict, or hosted API failure.
|
|
41
|
+
|
|
42
|
+
## API Contracts
|
|
43
|
+
|
|
44
|
+
The hosted API publishes typed contracts for agent clients:
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
platform-todos api get /api/v1/openapi.json --json
|
|
48
|
+
platform-todos docs catalog --surface api --json
|
|
49
|
+
platform-todos docs catalog --surface api --exposure-profile read-only --json
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
The OpenAPI document is for generated HTTP clients. The docs catalog is for
|
|
53
|
+
agents that need operation permissions, input/output schemas, and examples
|
|
54
|
+
across API, CLI, MCP, and SDK surfaces before choosing a tool.
|
|
55
|
+
|
|
56
|
+
Install and update with Bun:
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
bun install -g @hasna/platform-todos-cli
|
|
60
|
+
bun update -g @hasna/platform-todos-cli
|
|
61
|
+
```
|