@sanity/runtime-cli 17.3.2 → 17.4.0-blueprinit.g596ac51

package/skills/functions-logs.md

@@ -0,0 +1,39 @@
+# `npx @sanity/cli functions logs`
+
+Fetch, stream, or delete logs for one deployed Function. Always provide the Function name; omitting it only prints valid names and command help.
+
+Run from the Blueprint directory or a subdirectory; the manifest supplies the valid Function names.
+
+## Fetch logs
+
+Prefer a bounded, structured query for agent work:
+
+```sh
+npx @sanity/cli functions logs process-order --limit 100 --json
+```
+
+`--limit` defaults to 50. Entries without both a level and a message are dropped, so a returned count can be lower than the limit even when more logs exist.
+
+When entries are found, the JSON result contains a `logs` array of `{time, requestId, level, message}`. Human-readable output drops `requestId` and prints local timestamps unless `--utc` is passed. Pass `--stack NAME_OR_ID` to override the locally configured Stack.
+
+Logs may contain payload data or application secrets. Summarize only what is needed and do not reproduce credentials or personal data.
+
+## Stream logs
+
+`--watch` (alias `--follow`, `-w`) keeps running until interrupted and emits human-readable output:
+
+```sh
+npx @sanity/cli functions logs process-order --watch
+```
+
+`--watch` cannot be combined with `--json`. Streamed timestamps are always UTC, so `--utc` is ignored. Use watch mode only when continuous monitoring is requested, and stop it when monitoring is complete.
+
+## Delete logs
+
+Deleting removes all logs for the Function. Obtain explicit authorization and confirm the Function and Stack first:
+
+```sh
+npx @sanity/cli functions logs process-order --delete
+```
+
+The command prompts (defaulting to no) unless `--force` is supplied, and `--force` requires `--delete`. Use `--force` only for an authorized non-interactive deletion. `--delete` is rejected alongside `--limit` or `--json`.

package/skills/functions-test.md

@@ -0,0 +1,31 @@
+# `npx @sanity/cli functions test`
+
+Invoke a local Function with a test payload. Local execution can still make network requests or mutate external systems, so inspect the handler and payload before running it.
+
+## Run a bounded test
+
+Always provide the Function name. Prefer a JSON file for nontrivial payloads:
+
+```sh
+npx @sanity/cli functions test process-order --file payload.json --json
+```
+
+Use `--data '{"orderId":"order-123"}'` for a small inline JSON object. `--data`, `--file`, and `--document-id` are alternative input modes, and each must resolve to a JSON object. File paths are joined to the current working directory, so pass relative paths.
+
+Payloads reach document and media-library Functions only. Scheduled and sync-tag-invalidation Functions are invoked with a fixed scheduled event, and any payload flag is accepted and then ignored.
+
+For document and media-library Functions, the event defaults to `create` and also accepts `update` and `delete`. For an update event, provide one complete before/after pair:
+
+```sh
+npx @sanity/cli functions test process-order --event update --file-before before.json --file-after after.json --json
+```
+
+The Blueprint's `event.filter` and `event.projection` are applied to the payload before the handler runs, and a payload the filter excludes is skipped rather than executed. `--timeout SECONDS` overrides the Function's configured `timeout` for this run (default 10 seconds).
+
+## Remote data and credentials
+
+`--document-id` fetches a document (`--project-id`, `--dataset`) or a media-library asset (`--media-library-id`) with the CLI's stored token before local execution. `--api` sets the API version used for that fetch.
+
+`--with-user-token` injects the authenticated CLI token into the Function context. Use it only for trusted local code when authenticated API behavior is part of the test. Never include the token in payloads or output.
+
+The JSON result contains logs and any Function response. Review logs for sensitive data before sharing them.