@ycadence/cli 0.1.0 → 0.2.1

package/README.md

@@ -1,7 +1,8 @@
 # @ycadence/cli
 
-Work with YCadence from the command line: list, create, show and close work items,
-read states and cycles, and run imports from CSV, Jira, Linear or GitHub exports.
+Work with YCadence from the command line: list, create, update, close and move work
+items, read and set up states, labels, cycles and views, triage intake, and run imports
+from CSV, Jira, Linear or GitHub exports.
 
 ## Install
 
@@ -31,11 +32,24 @@ the name from before the rename.
 
 ## Configure
 
+```sh
+ycadence login --url https://ycadence.example.com --api-key-stdin < key.txt
+ycadence config set project <projectId>      # a default project for this profile
+ycadence doctor                              # checks configuration and connectivity
+```
+
+Profiles live in `~/.config/ycadence/config.json` (`$XDG_CONFIG_HOME` aware); switch with
+`--profile <name>` or `ycadence config use <name>`. The API key is kept in the OS keychain
+(macOS Keychain, or the Secret Service through `secret-tool`), else in a `credentials.json`
+with mode 0600. For an instance behind Google IAP, `ycadence login --oauth-client-id …
+--iap-audience …` signs in with Google and refreshes the identity token itself.
+
+Environment variables still win, so CI needs nothing else:
+
 ```sh
 export YCADENCE_URL=https://ycadence.example.com
 export YCADENCE_API_KEY=yc_live_p_...        # a project, organization or personal key
 export YCADENCE_IDENTITY_TOKEN=...           # only behind Google IAP; lasts about an hour
-ycadence doctor                              # checks configuration and connectivity
 ```
 
 When a `YCADENCE_*` variable is unset, the CLI reads the older `DEVPULSE_*` name
@@ -43,20 +57,31 @@ instead, and `doctor` tells you which one it used.
 
 ## Commands
 
+`ycadence <resource> <verb> [arguments] [flags]`. The full, generated reference is
+[docs/cli/reference.md](https://github.com/YarlisAISolutions/dev-pulse/blob/main/docs/cli/reference.md).
+
 ```
-ycadence doctor
-ycadence work-item list <projectId>
-ycadence work-item create <projectId> --title "..." [--priority high]
-ycadence work-item show <workItemId>
-ycadence work-item close <workItemId>
-ycadence states <projectId>
-ycadence cycles <projectId>
-ycadence import preview <projectId> --source csv --file issues.csv
-ycadence import run <projectId> --source csv --file issues.csv [--map "Done=<stateId>"]
-ycadence import status <runId>
-ycadence import list <projectId>
+ycadence work list|get|create|update|close|transition|delete
+ycadence states list            ycadence labels list|create
+ycadence cycles list|show|create|add
+ycadence views list|create      ycadence types list
+ycadence intake list|submit|triage
+ycadence import preview|run|status|list
+ycadence login                  ycadence auth status|logout|token
+ycadence config list|get|set|unset|profiles|use|path
+ycadence doctor                 ycadence completion bash|zsh|fish
 ```
 
+Every command takes `--format json` (a stable `{ ok, data, nextCursor, requestId }`
+envelope; errors go to stderr as `{ ok: false, error: { code, message, status, … } }`),
+`--fields`, `--quiet`, `--verbose`, `--dry-run` for writes, `--idempotency-key`, `--retry`,
+`--limit`, `--cursor` and `--all`. Exit codes: 0 ok, 1 failure, 2 usage, 3 not found,
+4 permission, 5 conflict, 6 validation, 75 temporary (retry), 78 configuration.
+
+The original commands still work, with a deprecation notice: `work-item list|create|show|close`,
+`states <projectId>`, `cycles <projectId>`, and `import preview|run|list <projectId>`.
+For a short name, `alias yc=ycadence`.
+
 Requires Node 18 or later. The package is self-contained and installs no other packages.
 
 ## License