@tsuga/cli 1.0.12 → 1.0.15

package/README.md

@@ -37,7 +37,7 @@ Priority order: `--operation-api-key` flag → `TSUGA_OPERATION_API_KEY` env var
 
 ## Configuration
 
-Show current configuration:
+Show current configuration (includes defaults):
 
 ```bash
 tsuga config
@@ -57,26 +57,22 @@ Commands have built-in defaults so you can omit common flags:
 Override defaults persistently:
 
 ```bash
-tsuga defaults set from -1h
-tsuga defaults set query 'level:ERROR'
+tsuga config set default from -1h
+tsuga config set default query 'level:ERROR'
 ```
 
-View all current defaults (custom overrides marked with `*`):
-
-```bash
-tsuga defaults
-```
+Current defaults are listed by `tsuga config` (custom overrides marked with `*`).
 
 Reset all custom defaults:
 
 ```bash
-tsuga defaults reset
+tsuga config reset defaults
 ```
 
 Clear a single default by setting it to an empty value:
 
 ```bash
-tsuga defaults set cluster ''
+tsuga config set default cluster ''
 ```
 
 ## Clusters
@@ -90,7 +86,7 @@ tsuga cluster list
 Pick the cluster you want to use by default via the defaults mechanism:
 
 ```bash
-tsuga defaults set cluster <cluster-id>
+tsuga config set default cluster <cluster-id>
 ```
 
 Override per-command without persisting:
@@ -130,15 +126,26 @@ You can also pass JSON inline with `-d`:
 tsuga teams create -d '{"name": "Platform", "visibility": "public"}'
 ```
 
+### Explaining a call with `--rationale`
+
+API-calling commands accept an optional `--rationale` flag to record why they are being run.
+It does not change the result; the text is sent as a request header and recorded in the
+backend request log, which is useful for understanding agent behavior.
+
+```bash
+tsuga logs patterns --rationale "exploring telemetry to investigate prod outage"
+```
+
 ### Available resources
 
-`cloud-resources`, `dashboards`, `ingestion-api-keys`, `monitors`, `notification-rules`, `notification-silences`, `quality-reports`, `retention-policies`, `routes`, `services`, `tag-policies`, `teams`
+`cloud-resources`, `dashboards`, `ingestion-api-keys`, `investigations`, `monitors`, `notification-rules`, `notification-silences`, `quality-reports`, `retention-policies`, `routes`, `services`, `tag-policies`, `teams`
 
 > Notes:
 >
 > - `ingestion-api-keys` does not support `get <id>`.
 > - `services` is read-only (`list`, `get`).
 > - `cloud-resources` and `quality-reports` are read-only and only support `list`.
+> - `investigations` is beta: it requires an operation API key with the `investigations` permission and the API may change.
 
 ### Generating a request skeleton
 
@@ -167,7 +174,7 @@ tsuga monitors list
 tsuga dashboards get abc-123
 
 # List dashboards filtered by owner
-tsuga dashboards list --owners team-1 team-2
+tsuga dashboards list -d '{"filters":{"owners":{"values":["team-1","team-2"]}}}'
 
 # Get a specific service
 tsuga services get abc-123
@@ -321,6 +328,14 @@ tsuga docs search 'log routes'
 tsuga docs get getting-started/send-your-first-logs
 ```
 
+## Feedback
+
+Report friction with Tsuga tools or APIs (a failing command, unusable output, confusing behavior):
+
+```bash
+tsuga feedback the traces command keeps timing out on large services
+```
+
 ## Tips
 
 Default output is JSON, so you can pipe to `jq`: