promptscript
starsforks
How to install promptscript?
mrwogu/promptscript
$git clone https://github.com/mrwogu/promptscriptAgent platform configuration as code
README.md
| 1 | <div align="center"> |
| 2 | <img src="docs/assets/logo.svg" alt="PromptScript logo" width="200" /> |
| 3 | |
| 4 | # PromptScript |
| 5 | |
| 6 | **Agent platform configuration as code** |
| 7 | |
| 8 | _Define instructions, skills, agents, MCP servers, hooks, workflows, and policies once. Compile |
| 9 | native configuration for 48 AI coding platforms._ |
| 10 | |
| 11 | [](https://github.com/mrwogu/promptscript/actions/workflows/ci.yml) |
| 12 | [](https://codecov.io/github/mrwogu/promptscript) |
| 13 | [](https://www.npmjs.com/package/@promptscript/cli) |
| 14 | [](https://github.com/mrwogu/promptscript/pkgs/container/promptscript) |
| 15 | [](https://opensource.org/licenses/MIT) |
| 16 | [](https://marketplace.visualstudio.com/items?itemName=promptscript.promptscript-language) |
| 17 | |
| 18 | [**Get started**](https://getpromptscript.dev/getting-started/) · |
| 19 | [**Try the playground**](https://getpromptscript.dev/playground/) · |
| 20 | [**Explore all features**](https://getpromptscript.dev/features/) · |
| 21 | [**View target matrix**](https://getpromptscript.dev/reference/formatters/) |
| 22 | |
| 23 | </div> |
| 24 | |
| 25 | --- |
| 26 | |
| 27 | AI coding tools no longer consume one instruction file. They discover skills, specialist agents, |
| 28 | commands, MCP integrations, hooks, workflows, and platform-specific settings from different paths |
| 29 | and schemas. Managing these files by hand creates drift between tools, repositories, and teams. |
| 30 | |
| 31 | PromptScript turns that surface area into one validated, composable, Git-native source: |
| 32 | |
| 33 | ```text |
| 34 | PromptScript source |
| 35 | -> resolve inheritance, imports, and policies |
| 36 | -> validate language and capabilities |
| 37 | -> compile deterministic target-native files |
| 38 | ``` |
| 39 | |
| 40 | No runtime proxy. No lowest-common-denominator output. Each formatter emits the richest native |
| 41 | representation its platform supports. |
| 42 | |
| 43 | ## Quick Start |
| 44 | |
| 45 | ```bash |
| 46 | npm install -g @promptscript/cli |
| 47 | |
| 48 | prs init |
| 49 | # Edit .promptscript/project.prs |
| 50 | prs validate --strict |
| 51 | prs compile |
| 52 | ``` |
| 53 | |
| 54 | `prs init` detects the project stack and installed AI tools, then creates a clean |
| 55 | `promptscript.yaml` and `.promptscript/project.prs`. Detected targets are preselected, while other |
| 56 | targets remain explicit choices. For automation, use `prs init --yes --targets claude factory`. |
| 57 | Hooks are installed by default. Use `--no-hooks` to skip hook installation or `--dry-run` to |
| 58 | preview all writes. |
| 59 | |
| 60 | Prefer no local installation? |
| 61 | |
| 62 | ```bash |
| 63 | docker run --rm -v "$(pwd):/workspace" ghcr.io/mrwogu/promptscript:latest validate --strict |
| 64 | ``` |
| 65 | |
| 66 | Or [open the playground](https://getpromptscript.dev/playground/) and compile in the browser. |
| 67 | |
| 68 | ## Define a Complete Agent Platform |
| 69 | |
| 70 | `.promptscript/project.prs`: |
| 71 | |
| 72 | ```promptscript |
| 73 | @meta { |
| 74 | id: "checkout-service" |
| 75 | syntax: "1.4.0" |
| 76 | } |
| 77 | |
| 78 | @identity { |
| 79 | """ |
| 80 | You are working on the checkout service. |
| 81 | Preserve transaction integrity and auditability. |
| 82 | """ |
| 83 | } |
| 84 | |
| 85 | @standards { |
| 86 | code: ["Use strict TypeScript", "Test every business rule"] |
| 87 | } |
| 88 | |
| 89 | @shortcuts { |
| 90 | "/review": { |
| 91 | prompt: true |
| 92 | description: "Review current changes" |
| 93 | content: "Review correctness, security, tests, and operational impact." |
| 94 | } |
| 95 | } |
| 96 | |
| 97 | @skills { |
| 98 | security-review: { |
| 99 | description: "Review payment changes for security risks" |
| 100 | allowedTools: ["Read", "Grep", "Bash"] |
| 101 | content: "Inspect authentication, authorization, secrets, and payment data handling." |
| 102 | } |
| 103 | } |
| 104 | |
| 105 | @mcpServers { |
| 106 | issue-tracker: { |
| 107 | transport: "stdio" |
| 108 | command: ["node", "./tools/issues.mjs"] |
| 109 | } |
| 110 | } |
| 111 | |
| 112 | @agents { |
| 113 | reviewer: { |
| 114 | description: "Review changes before merge" |
| 115 | tools: ["Read", "Grep", "Glob", "Bash"] |
| 116 | skills: ["security-review"] |
| 117 | mcpServers: ["issue-tracker"] |
| 118 | content: "Review changed code, tests, and operational impact." |
| 119 | } |
| 120 | } |
| 121 | |
| 122 | @hooks { |
| 123 | validate-changes: { |
People who liked this also viewed
6 picksType
- components-helperBased on the docs to provide code prompt files for vue component libraryPromptsNov 2023
- VibeCode-Protocol-SuiteA comprehensive suite of protocols, meta-prompts, and orchestration tools designed to streamline software development workflows, project management, and team collaboration. Includes the VibeCode Protocol Suite with web interface, user manuals, and reusable templates for efficient development processes.PromptsJul 2026
- Promptable-web-sdkWeb SDK for Promptable Website.PromptsDec 2022
- LLMFlexA python package for developing AI applications with local LLMs.PromptsJan 2025
- cli-repo-to-promptexport any codebase to a single LLM-ready markdown promptPromptsJul 2026
- Files2PromptVS Code extension to copy files for an LLM promptPromptsApr 2025
