@promptscript/cli 1.19.0 → 1.20.0

package/README.md

@@ -8,6 +8,8 @@ Define instructions, skills, agents, MCP servers, hooks, workflows, and policies
 native configuration for 50 AI coding platforms.
 
 [![npm version](https://img.shields.io/npm/v/@promptscript/cli.svg)](https://www.npmjs.com/package/@promptscript/cli)
+[![Node.js 20+](https://img.shields.io/badge/Node.js-20%2B-5FA04E?logo=nodedotjs&logoColor=white)](https://getpromptscript.dev/getting-started/#installation)
+[![Deno 2.9+](https://img.shields.io/badge/Deno-2.9%2B-70FFAF?logo=deno&logoColor=000000)](https://getpromptscript.dev/reference/cli/#running-under-deno)
 [![CI](https://github.com/mrwogu/promptscript/actions/workflows/ci.yml/badge.svg)](https://github.com/mrwogu/promptscript/actions/workflows/ci.yml)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/mrwogu/promptscript/blob/main/LICENSE)
 
@@ -20,9 +22,19 @@ native configuration for 50 AI coding platforms.
 
 [![Watch the PromptScript introduction](https://img.youtube.com/vi/7sHMn-DbZig/maxresdefault.jpg)](https://youtu.be/7sHMn-DbZig)
 
-AI coding platforms use different files for instructions, skills, agents, commands, MCP
-integrations, hooks, and settings. PromptScript replaces hand-maintained copies with one validated,
-composable, Git-native source and target-specific compilers.
+## What is PromptScript?
+
+PromptScript is an open-source language and compiler for AI agent configuration. `.prs` sources
+define instructions, project standards, restrictions, skills, agents, MCP servers, hooks, and
+workflows, while `promptscript.yaml` configures targets and extension-compliance policies.
+PromptScript compiles them into the native files each AI tool already reads, including `CLAUDE.md`,
+`.github/copilot-instructions.md`, `.cursor/rules`, and output for 47 more targets.
+
+Every AI coding tool uses its own file names, formats, and paths. Teams using several tools end up
+maintaining several copies of the same rules. Those copies drift, and a change made for one tool may
+never reach the others.
+
+PromptScript fixes the source instead of patching each generated file:
 
 ```text
 .promptscript/project.prs
@@ -33,6 +45,16 @@ composable, Git-native source and target-specific compilers.
 
 No runtime proxy. Each selected platform keeps consuming its own native configuration.
 
+## Why maintain native files by hand?
+
+Even a few tools create copies that need the same manual updates. Errors stay hidden until an agent
+reads the broken file. Policy changes become separate edits across every repository and tool.
+
+With PromptScript, you change one source, review the generated diff, and validate it in CI. Git
+records each change. Remote dependencies stay pinned in `promptscript.lock`, so builds remain
+reproducible. Adding or switching tools does not require rewriting the source. See the
+[full comparison](https://getpromptscript.dev/guides/vs-manual/).
+
 ## Install
 
 Requires Node.js 20 or later.
@@ -54,6 +76,48 @@ Verify installation:
 prs --version
 ```
 
+## Running under Deno
+
+The CLI also runs on Deno 2.9 or later, either straight from the installed
+package or compiled into a standalone binary that needs no other runtime.
+
+In any project that has `@promptscript/cli` in its dependencies, point Deno at
+the installed bin shim:
+
+```bash
+deno run --allow-env --allow-sys --allow-read --allow-write --allow-net --allow-run node_modules/@promptscript/cli/bin/prs.js init
+```
+
+An `npm:@promptscript/cli` specifier resolves the published registry release
+instead of the version installed in `node_modules`, so use the path above
+whenever the project's own dependency is what should run.
+
+Compile a self-contained `prs` binary, for example for CI images or machines
+without Node:
+
+```bash
+deno compile --allow-env --allow-sys --allow-read --allow-write --allow-net --allow-run -o prs node_modules/@promptscript/cli/bin/prs.js
+./prs --version
+```
+
+Add `--target x86_64-unknown-linux-gnu` (or `aarch64-unknown-linux-gnu`,
+`x86_64-pc-windows-msvc`) to cross-compile for another platform.
+
+What the permissions are for:
+
+| Flag                            | Used for                                              |
+| ------------------------------- | ----------------------------------------------------- |
+| `--allow-env`, `--allow-sys`    | runtime detection, configuration, telemetry           |
+| `--allow-read`, `--allow-write` | project files, caches, vendored dependencies          |
+| `--allow-net`                   | registries, update checks, telemetry delivery         |
+| `--allow-run`                   | git subprocesses, pagers, clipboard, guarded cleanups |
+
+Guarded managed-output cleanup re-executes the CLI through a hidden worker
+command: under `deno run` the worker is spawned with read and write access
+scoped to the output directory, and a compiled binary re-executes itself.
+Telemetry reports `runtime: deno` and is disabled with `DO_NOT_TRACK=1`.
+Node.js 20+ remains fully supported with unchanged behavior.
+
 ## 60-Second Quick Start
 
 ```bash