@granular-software/sdk 0.4.8 → 0.4.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -0
- package/dist/cli/index.js +896 -245
- package/dist/index.d.mts +136 -1
- package/dist/index.d.ts +136 -1
- package/dist/index.js +303 -111
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +303 -111
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -48,6 +48,14 @@ CLI overrides:
|
|
|
48
48
|
- `granular --prod <command>`
|
|
49
49
|
- `granular --env local|production <command>`
|
|
50
50
|
|
|
51
|
+
## Agent documentation (CLI)
|
|
52
|
+
|
|
53
|
+
Projects created with `granular init` can include Markdown for coding agents (optional `AGENTS.md` plus generated guides):
|
|
54
|
+
|
|
55
|
+
- **`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).
|
|
56
|
+
- **`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).
|
|
57
|
+
- **`AGENTS.md`** — Two-step index: manifest guide first, then sandbox doc (merged idempotently with `<!-- granular-sdk:begin -->`).
|
|
58
|
+
|
|
51
59
|
## Quick Start
|
|
52
60
|
|
|
53
61
|
```typescript
|