Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -278,3 +278,18 @@ at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in this project by you, as defined in the Apache-2.0 license,
shall be dual licensed as above, without any additional terms or conditions.

## Development

To make the global `plannotator` command run from this checkout:

```bash
bun install
bun link
```

After linking, commands like `plannotator review` use `apps/hook/server/index.ts` from your local repo. Rebuild the bundled HTML when changing UI code:

```bash
bun run --cwd apps/review build && bun run build:hook
```
24 changes: 24 additions & 0 deletions bin/plannotator.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
#!/usr/bin/env node
const childProcess = require("node:child_process");
const fs = require("node:fs");
const path = require("node:path");

const repoRoot = path.resolve(path.dirname(__filename), "..");
const sourceEntry = path.join(repoRoot, "apps", "hook", "server", "index.ts");

if (!fs.existsSync(sourceEntry)) {
console.error(`Could not find Plannotator source entry at ${sourceEntry}`);
process.exit(1);
}

const result = childProcess.spawnSync("bun", [sourceEntry, ...process.argv.slice(2)], {
cwd: process.cwd(),
stdio: "inherit",
});

if (result.error) {
console.error(result.error.message);
process.exit(1);
}

process.exit(typeof result.status === "number" ? result.status : 0);
3 changes: 3 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
"description": "Interactive Plan Review for Claude Code - annotate plans visually, share with team, automatically send feedback",
"author": "backnotprop",
"license": "MIT OR Apache-2.0",
"bin": {
"plannotator": "bin/plannotator.js"
},
"repository": {
"type": "git",
"url": "git+https://github.com/backnotprop/plannotator.git"
Expand Down