@typescape-ai/cli 1.9.18 → 1.9.21

package/README.md

@@ -4,16 +4,19 @@ Typescape CLI — agent-first review, finding, and rules workflows for Markdown.
 
 ## Requirements
 
-- [Bun](https://bun.sh/) 1.3.10+ (repository standard; Node package-manager flows are not supported here)
+- [Bun](https://bun.sh/) 1.3.10+ or [Node.js](https://nodejs.org/) 18.17+
 
 ## Installation
 
 ```bash
-# Global install
+# Global install with Bun
 bun add -g @typescape-ai/cli
 
-# Or install in a project
+# Or install in a project with Bun
 bun add -D @typescape-ai/cli
+
+# Node-based one-shot launch
+npx -y @typescape-ai/cli
 ```
 
 Run without installing:
@@ -42,6 +45,10 @@ export TYPESCAPE_API_KEY=your-token-here
 typescape rules get --properties '{"doc_type":"procedure"}'
 ```
 
+`rules get --format text` now prepends a metadata block with the bundle
+`compiled_hash`, freshness, and applicability basis. Use `--format prompt`
+when you need the raw prompt-friendly text only.
+
 4. Create a review:
 
 ```bash
@@ -54,6 +61,10 @@ typescape review create --file docs/README.md --reviewer alice@example.com
 typescape rules check --file docs/README.md --properties '{"doc_type":"procedure"}'
 ```
 
+`rules check` exit codes are policy-aware: `0` means the check ran with no
+blocking findings, `1` means the check ran and found blocking findings, `2`
+is validation, `3` is network/auth, and `4` is a server error.
+
 6. Export feedback:
 
 ```bash
@@ -131,8 +142,8 @@ typescape review export --review rev_xxx
 | `project delete`    | Start project deletion                                 |
 | `project move`      | Declare a project file-path move                       |
 | `project upload`    | Upload files into a project batch                      |
-| `template create`   | Create a reusable session template                     |
-| `template list`     | List session templates                                 |
+| `template create`   | Create a reusable review template                      |
+| `template list`     | List review templates                                  |
 | `template get`      | Get template detail                                    |
 | `review-set create` | Create a multi-file review set                         |
 | `review-set list`   | List review sets                                       |
@@ -141,8 +152,8 @@ typescape review export --review rev_xxx
 | `review-set export` | Export a review set using compatibility-only schema=v1 |
 | `review-set status` | Evaluate aggregate review-set policy status            |
 | `collection create` | Create a new collection                                |
-| `collection add`    | Add sessions to a collection                           |
-| `collection get`    | Get one collection with member sessions                |
+| `collection add`    | Add reviews to a collection                            |
+| `collection get`    | Get one collection with member reviews                 |
 | `collection list`   | List collections                                       |
 | `collection update` | Update collection metadata or archive state            |
 | `collection delete` | Archive a collection via the canonical PATCH surface   |

package/bin/typescape

@@ -0,0 +1,17 @@
+#!/usr/bin/env sh
+set -eu
+
+SCRIPT_DIR="$(CDPATH= cd -- "$(dirname -- "$0")" && pwd)"
+
+if command -v node >/dev/null 2>&1; then
+  exec node "$SCRIPT_DIR/../dist/cli.js" "$@"
+fi
+
+if command -v bun >/dev/null 2>&1; then
+  exec bun "$SCRIPT_DIR/../dist/cli.js" "$@"
+fi
+
+echo "Typescape CLI requires Node.js (>=18) or Bun." >&2
+echo "Install Node.js: https://nodejs.org/" >&2
+echo "Install Bun: https://bun.sh/docs/installation" >&2
+exit 127