@promptscript/cli 1.0.0-rc.3 → 1.1.0

package/CHANGELOG.md

@@ -5,6 +5,28 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.1.0](https://github.com/mrwogu/promptscript/compare/v1.0.0...v1.1.0) (2026-03-11)
+
+
+### Features
+
+* add Factory AI, OpenCode, and Gemini CLI compilation targets ([9c206af](https://github.com/mrwogu/promptscript/commit/9c206af40fe35412b948b1a32d9fec8b309e3c91))
+* add root SKILL.md as canonical source with sync pipeline ([#75](https://github.com/mrwogu/promptscript/issues/75)) ([cc76023](https://github.com/mrwogu/promptscript/commit/cc76023eaea92318303081dcd439ae3185b1bbe0))
+* **cli:** enterprise registry redesign ([#74](https://github.com/mrwogu/promptscript/issues/74)) ([a1ce2ca](https://github.com/mrwogu/promptscript/commit/a1ce2cad2a80d902e380907dd5b1c474952f8b6f))
+* new formatters ([#78](https://github.com/mrwogu/promptscript/issues/78)) ([b30585a](https://github.com/mrwogu/promptscript/commit/b30585ae483a3c02b690ab8755ccd44f9cf355a7))
+
+
+### Bug Fixes
+
+* **cli:** include skills in build assets and update CI smoke tests ([62d8d0b](https://github.com/mrwogu/promptscript/commit/62d8d0bbc86f02ad11424110fb7bf2215dd80299))
+
+## [1.0.0](https://github.com/mrwogu/promptscript/compare/v1.0.0-rc.3...v1.0.0) (2026-03-06)
+
+
+### chore
+
+* prepare release ([d751e4b](https://github.com/mrwogu/promptscript/commit/d751e4bd7bc82d834766980bb0eba71dfd7bf92f))
+
 ## [1.0.0-rc.3](https://github.com/mrwogu/promptscript/compare/v1.0.0-rc.2...v1.0.0-rc.3) (2026-02-03)
 
 

package/README.md

@@ -1,39 +1,159 @@
 # @promptscript/cli
 
-> Part of the [PromptScript](https://github.com/mrwogu/promptscript) ecosystem - The Prompt-as-Code for AI Instructions.
+**One source of truth for all your AI coding assistants.**
 
-Command-line interface for PromptScript. Compile, validate, and manage AI instructions at enterprise scale.
+Write AI instructions once in PromptScript, compile to GitHub Copilot, Claude Code, Cursor, Antigravity, and more.
 
-## 🏗️ Architecture
+[![npm version](https://img.shields.io/npm/v/@promptscript/cli.svg)](https://www.npmjs.com/package/@promptscript/cli)
+[![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://opensource.org/licenses/MIT)
 
-The CLI bundles all internal packages into a single distributable:
+---
+
+## The Problem
+
+Every AI coding tool uses a different config format. As your organization grows, so does the chaos:
+
+```
+50 repos x 37 AI agents = 1850 files to maintain
+
+repo-1/CLAUDE.md          repo-1/.cursorrules      repo-1/.github/copilot-instructions.md
+repo-2/CLAUDE.md          repo-2/.cursorrules      repo-2/.github/copilot-instructions.md
+...
+repo-50/CLAUDE.md         repo-50/.cursorrules     repo-50/.github/copilot-instructions.md
+```
+
+- A security policy update means editing hundreds of files by hand
+- Standards drift across teams and repos
+- Switching AI tools means rewriting everything
+- No audit trail, no validation, no reuse
+
+## The Solution
+
+PromptScript lets you **build prompts like code** — with inheritance, composition, parameterization, and compilation to any target format:
 
 ```
-@promptscript/cli (published)
-│
-├─► compiler (pipeline orchestration)
-│   ├─► resolver
-│   ├─► validator ─────► core
-│   └─► formatters ────► core
-│
-└─► resolver (inheritance & import resolution)
-    ├─► parser ────────► core
-    └───────────────────► core
+.promptscript/project.prs  -->  prs compile  -->  CLAUDE.md
+                                              -->  .github/copilot-instructions.md
+                                              -->  .cursor/rules/project.mdc
+                                              -->  .agent/rules/project.md
 ```
 
-See the [PromptScript monorepo](https://github.com/mrwogu/promptscript) for development details.
+Update once, propagate everywhere. Version-controlled, validated, vendor-independent.
+
+---
 
-## Installation
+## Quick Start
 
 ```bash
+# Install
 npm install -g @promptscript/cli
-# or
-pnpm add -g @promptscript/cli
+
+# Initialize (auto-detects your tech stack)
+prs init
+
+# Compile to all configured AI tools
+prs compile
+```
+
+### Already have CLAUDE.md or .cursorrules?
+
+```bash
+# Auto-detect and migrate existing AI instruction files
+prs init --migrate
+```
+
+---
+
+## Example
+
+`.promptscript/project.prs`:
+
+```promptscript
+@meta { id: "checkout-service" syntax: "1.0.0" }
+
+@inherit @company/backend-security
+@use @fragments/testing
+@use @fragments/typescript-strict
+
+@identity {
+  """
+  You are an expert Backend Engineer working on the Checkout Service.
+  This service handles payments using hexagonal architecture.
+  """
+}
+
+@shortcuts {
+  "/review": "Security-focused code review"
+  "/test": "Write unit tests with Vitest"
+}
 ```
 
+Run `prs compile` and get correctly formatted output for every AI tool your team uses.
+
+---
+
 ## Commands
 
-### Initialize Project
+| Command                 | Description                                  |
+| :---------------------- | :------------------------------------------- |
+| `prs init`              | Initialize project with auto-detection       |
+| `prs compile`           | Compile to target AI tool formats            |
+| `prs compile -w`        | Watch mode — recompile on changes            |
+| `prs compile --dry-run` | Preview changes without writing files        |
+| `prs validate`          | Validate `.prs` files with detailed errors   |
+| `prs diff`              | Show diff between source and compiled output |
+| `prs pull`              | Pull updates from registry                   |
+| `prs update-check`      | Check for newer CLI versions                 |
+
+## Key Features
+
+- **Inheritance** — build org-wide, team-level, and project-level configs that cascade like CSS
+- **Composition** — reuse fragments across projects with `@use`
+- **Parameterized templates** — `@inherit @stacks/node(port: 8080, db: "postgres")`
+- **Multi-target compilation** — one source, any number of AI tools
+- **Watch mode** — instant recompilation on file changes
+- **Overwrite protection** — never accidentally clobbers hand-written files
+- **Validation** — catch errors before they reach your AI tools
+- **Registry support** — share configs via Git registries (private or public)
+- **AI-assisted migration** — convert existing `CLAUDE.md`, `.cursorrules`, etc.
+
+## Supported Targets
+
+| AI Tool                | Output                                                |
+| :--------------------- | :---------------------------------------------------- |
+| **GitHub Copilot**     | `.github/copilot-instructions.md`, agents, prompts    |
+| **Claude Code**        | `CLAUDE.md`, skills, local memory                     |
+| **Cursor**             | `.cursor/rules/*.mdc`                                 |
+| **Google Antigravity** | `.agent/rules/*.md`                                   |
+| **Factory AI**         | `AGENTS.md`, `.factory/skills/`, `.factory/commands/` |
+| **OpenCode**           | `agents.yaml`                                         |
+| **Gemini CLI**         | `GEMINI.md`                                           |
+
+## Configuration
+
+`promptscript.yaml`:
+
+```yaml
+version: '1'
+
+input:
+  entry: '.promptscript/project.prs'
+
+targets:
+  - github
+  - claude
+  - cursor
+  - factory
+  - opencode
+  - gemini
+```
+
+See the [full configuration reference](https://getpromptscript.dev/reference/config/) for registry auth, watch settings, validation rules, and more.
+
+## Detailed Command Usage
+
+### Init
 
 ```bash
 prs init [options]
@@ -43,7 +163,7 @@ Options:
   -t, --team <team>        Team namespace
   --inherit <path>         Inheritance path (e.g., @company/team)
   --registry <path>        Registry path
-  --targets <targets...>   Target AI tools (github, claude, cursor)
+  --targets <targets...>   Target AI tools (github, claude, cursor, opencode, gemini, ...)
   -i, --interactive        Force interactive mode
   -y, --yes                Skip prompts, use defaults
   -f, --force              Force reinitialize even if already initialized
@@ -62,7 +182,7 @@ Creates:
 prs compile [options]
 
 Options:
-  -t, --target <target>   Specific target (github, claude, cursor)
+  -t, --target <target>   Specific target (github, claude, cursor, opencode, gemini, ...)
   -a, --all               All configured targets (default)
   -w, --watch             Watch mode for continuous compilation (uses chokidar)
   -o, --output <dir>      Output directory
@@ -150,93 +270,22 @@ PROMPTSCRIPT_NO_UPDATE_CHECK=1 prs compile
 | `PAGER`                        | Custom pager for diff output (default: `less`) |
 | `NO_COLOR`                     | Set to disable colored output                  |
 
-## Configuration
-
-Create a `promptscript.yaml` file:
-
-```yaml
-version: '1'
-
-project:
-  id: my-project
-  team: frontend
-
-inherit: '@frontend/team'
-
-registry:
-  path: './registry'
-  cache: true # Enable HTTP registry caching
-  auth: # Authentication for HTTP registry
-    type: bearer
-    token: ${REGISTRY_TOKEN} # Environment variable interpolation
-
-input:
-  entry: '.promptscript/project.prs'
-  include:
-    - '.promptscript/**/*.prs'
-  exclude:
-    - '**/*.local.prs'
-
-output:
-  dir: '.' # Output base directory
-  clean: false # Clean output before compile
-  targets:
-    github: '.github/copilot-instructions.md'
-    claude: 'CLAUDE.md'
-    cursor: '.cursor/rules/project.mdc'
-
-watch:
-  debounce: 300 # Debounce time in ms
-  ignored:
-    - '**/node_modules/**'
-
-targets:
-  - github
-  - claude
-  - cursor
-
-validation:
-  requiredGuards:
-    - '@core/guards/compliance'
-  rules:
-    empty-block: warn
-```
-
-## Output Examples
-
-### Success
+## Docker
 
-```
-✔ Compilation successful
+No Node.js? Use the Docker image:
 
-  ✓ .github/copilot-instructions.md
-  ✓ CLAUDE.md
-  ✓ .cursor/rules/project.mdc
-
-Stats: 234ms (resolve: 45ms, validate: 8ms, format: 181ms)
-```
-
-### Watch Mode
-
-```
-👀 Watching for changes...
-
-[12:34:56] File changed: .promptscript/project.prs
-✔ Compilation successful (156ms)
-
-  ✓ .github/copilot-instructions.md
-  ✓ CLAUDE.md
+```bash
+docker run --rm -v $(pwd):/workspace ghcr.io/mrwogu/promptscript:latest compile
+docker run --rm -v $(pwd):/workspace ghcr.io/mrwogu/promptscript:latest validate --strict
 ```
 
-### Error
-
-```
-✖ Compilation failed
+## Documentation
 
-  ✗ @meta.id is required
-    at .promptscript/project.prs:1:1
-    suggestion: Add id: "your-id" to @meta
-```
+- [Getting Started](https://getpromptscript.dev/getting-started/) — 5-minute quickstart
+- [Language Reference](https://getpromptscript.dev/reference/syntax/) — full syntax docs
+- [Inheritance Guide](https://getpromptscript.dev/guides/inheritance/) — composition patterns
+- [Migration Guide](https://getpromptscript.dev/guides/migration/) — converting existing files
+- [Enterprise Guide](https://getpromptscript.dev/guides/enterprise/) — scaling across organizations
 
 ## License