augmtd
v0.1.0
Published
Read your tracked work in AUGMTD and propose next steps from a terminal. Read and propose only: nothing is sent until you approve it in AUGMTD.
Readme
augmtd
Read your tracked work in AUGMTD and propose next steps from a terminal or a script.
Read and propose only: a proposal waits for your approval in AUGMTD. Nothing is sent, posted, booked or applied from here.
npx augmtd login # paste a workspace key (Settings, Connections, API keys)
npx augmtd work list
npx augmtd work get <id>
npx augmtd propose reply --inbox-item-id <id> --body "Thanks, the quote follows on Monday."
npx augmtd help # every command the API offers today
npx augmtd help propose promiseAdd --json to any command for the raw answer (for jq and scripts). A flag given as - reads its value from
stdin (... --body - < reply.txt).
Commands come from the API
The CLI ships no list of operations. On every run it reads the API's OpenAPI document
(/api/v1/openapi.json) and builds its commands from it, so a new operation is a command the day the API offers
it, with no new release. An operation list_x is augmtd x list, get_x is augmtd x get <id>, propose_x is
augmtd propose x; the operation's own name works too (augmtd list_x).
Settings
| | |
|---|---|
| --base-url URL / AUGMTD_BASE_URL | the AUGMTD address (default https://app.augmtd.ai) |
| AUGMTD_KEY | a key for this run, instead of the saved one |
| AUGMTD_CONFIG | where the key is saved (default ~/.config/augmtd/config.json, readable by you only) |
A saved key is only ever sent to the address it was saved for. augmtd logout forgets it; revoke it in AUGMTD to
stop it working.
Requires Node.js 20 or later. No dependencies.
License
Apache-2.0 (see LICENSE). The licence covers this command only; it grants no right to the AUGMTD name or service.
