@granular-software/sdk 0.4.9 → 0.4.11

package/README.md

@@ -48,6 +48,16 @@ CLI overrides:
 - `granular --prod <command>`
 - `granular --env local|production <command>`
 
+When the resolved API URL points at `localhost` or `127.0.0.1`, the SDK and CLI automatically swap opaque `sk_...` WorkOS keys for the local dev key `gn_sk_tenant_default_principal_local_e2e_00000000` so local runs work without server-side WorkOS validation. Override with `GRANULAR_LOCAL_API_KEY=...` or disable with `GRANULAR_DISABLE_LOCAL_API_KEY_FALLBACK=true`.
+
+## Agent documentation (CLI)
+
+Projects created with `granular init` can include Markdown for coding agents (optional `AGENTS.md` plus generated guides):
+
+- **`docs/granular-manifest.md`** — **What Granular is**, glossary, manifest → build → connect → jobs, **`granular.json`** syntax (**fields**, **relationships**, **effects**), **`@granular-software/sdk`** map, CLI. Self-contained for agents new to the product. Added when you opt in at init (`--agent-docs` / `--no-agent-docs`, or the prompt).
+- **`GRANULAR_SANDBOX.md`** — **This sandbox’s ontology** snapshot: ids, exact names/keys, effect schemas, snippets. Updated after each successful **`granular build`**, **`granular deploy`**, and **`granular dev`** rebuild, and on **`granular document`** (run `build` to record manifest/build ids).
+- **`AGENTS.md`** — Two-step index: manifest guide first, then sandbox doc (merged idempotently with `<!-- granular-sdk:begin -->`).
+
 ## Quick Start
 
 ```typescript