@brickhouse-tech/sync-agents 0.2.6 → 0.3.0

package/README.md

@@ -6,29 +6,48 @@ AGENTS.md serves as an auto-generated index of everything in `.agents/` and is s
 
 ## Installation
 
-### npm
+### npm (recommended for Node.js projects)
+
+Ships native Go binaries via per-platform optional packages — no build step required.
 
 ```bash
-npm install @brickhouse-tech/sync-agents
+npm install -g @brickhouse-tech/sync-agents
 ```
 
-or globally:
+Or as a project devDependency:
 
 ```bash
-npm install -g @brickhouse-tech/sync-agents
+npm install --save-dev @brickhouse-tech/sync-agents
+```
+
+### go install (no Node.js required)
+
+```bash
+go install github.com/brickhouse-tech/sync-agents@latest
 ```
 
-### Standalone (no npm required) — deprecated
+Requires Go 1.21+. The binary is placed in `$GOPATH/bin` (or `$HOME/go/bin`). Version is read from the module proxy at install time via `debug.ReadBuildInfo`.
 
-> **Deprecated.** The bash script is kept as a fallback for unsupported
-> triples but will be removed in a future major. Prefer the npm install
-> above; it ships native Go binaries via per-platform optional packages.
+### Homebrew
 
 ```bash
-curl -fsSL https://raw.githubusercontent.com/brickhouse-tech/sync-agents/main/src/sh/sync-agents.sh -o /usr/local/bin/sync-agents
-chmod +x /usr/local/bin/sync-agents
+brew install brickhouse-tech/tap/sync-agents
 ```
 
+The tap is updated automatically on every release via GoReleaser.
+
+### GitHub Releases (pre-built binaries)
+
+Download the archive for your platform from the [Releases page](https://github.com/brickhouse-tech/sync-agents/releases), extract, and place the binary on your `PATH`:
+
+```bash
+# Example: macOS arm64
+curl -fsSL https://github.com/brickhouse-tech/sync-agents/releases/latest/download/sync-agents_$(uname -s | tr '[:upper:]' '[:lower:]')_$(uname -m | sed 's/x86_64/amd64/').tar.gz | tar -xz
+sudo mv sync-agents /usr/local/bin/
+```
+
+SHA-256 checksums are published alongside each release as `checksums.txt`.
+
 ## Topology
 
 `.agents/` is the source of truth. It contains all rules, skills, workflows, and state for your agents:

package/bin/sync-agents.js

@@ -1,8 +1,7 @@
 #!/usr/bin/env node
-// Launcher: prefer the Go binary shipped via the matching platform package
-// (@brickhouse-tech/sync-agents-<os>-<arch>); fall back to the bash script
-// at src/sh/sync-agents.sh so the package never bricks on an unsupported
-// triple.
+// Launcher: resolve the Go binary shipped via the matching platform package
+// (@brickhouse-tech/sync-agents-<os>-<arch>). Exits with a clear error on
+// unsupported triples rather than silently falling back to a bash script.
 
 const { spawnSync } = require("node:child_process");
 const path = require("node:path");
@@ -17,22 +16,25 @@ function resolveGoBinary() {
     const candidate = path.join(path.dirname(pkgJson), "bin", exe);
     if (fs.existsSync(candidate)) return candidate;
   } catch {
-    // platform package not installed (npm skipped it via os/cpu mismatch
-    // or it failed as an optionalDependency); fall through to bash.
+    // platform package not installed or not available for this triple.
   }
   return null;
 }
 
-function fallbackShellScript() {
-  return path.join(__dirname, "..", "src", "sh", "sync-agents.sh");
-}
+const target = resolveGoBinary();
 
-const target = resolveGoBinary() ?? fallbackShellScript();
-const isShell = target.endsWith(".sh");
+if (!target) {
+  console.error(
+    `sync-agents: no pre-built binary for ${process.platform}/${process.arch}.\n` +
+    `Install via one of the supported channels:\n` +
+    `  go install github.com/brickhouse-tech/sync-agents@latest\n` +
+    `  brew install brickhouse-tech/tap/sync-agents\n` +
+    `  https://github.com/brickhouse-tech/sync-agents/releases`
+  );
+  process.exit(1);
+}
 
-const result = spawnSync(isShell ? "bash" : target, isShell ? [target, ...process.argv.slice(2)] : process.argv.slice(2), {
-  stdio: "inherit",
-});
+const result = spawnSync(target, process.argv.slice(2), { stdio: "inherit" });
 
 if (result.error) {
   console.error(`sync-agents: failed to exec ${target}: ${result.error.message}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brickhouse-tech/sync-agents",
-  "version": "0.2.6",
+  "version": "0.3.0",
   "description": "Simple scripts to DRY up common agent interactions across multiple LLM providers.",
   "keywords": [
     "agents",
@@ -23,26 +23,27 @@
     "sync-agents": "bin/sync-agents.js"
   },
   "files": [
-    "bin/sync-agents.js",
-    "src/**/*"
+    "bin/sync-agents.js"
   ],
   "optionalDependencies": {
-    "@brickhouse-tech/sync-agents-darwin-arm64": "0.2.6",
-    "@brickhouse-tech/sync-agents-darwin-x64": "0.2.6",
-    "@brickhouse-tech/sync-agents-linux-arm64": "0.2.6",
-    "@brickhouse-tech/sync-agents-linux-x64": "0.2.6",
-    "@brickhouse-tech/sync-agents-win32-x64": "0.2.6"
+    "@brickhouse-tech/sync-agents-darwin-arm64": "0.3.0",
+    "@brickhouse-tech/sync-agents-darwin-x64": "0.3.0",
+    "@brickhouse-tech/sync-agents-linux-arm64": "0.3.0",
+    "@brickhouse-tech/sync-agents-linux-x64": "0.3.0",
+    "@brickhouse-tech/sync-agents-win32-x64": "0.3.0"
   },
   "overrides": {
     "file-type": ">=22",
     "picomatch": ">=4.0.4"
   },
   "scripts": {
-    "lint": "shellcheck src/sh/*.sh",
-    "test": "npx concurrently --names \"sh,go\" -c \"cyan,magenta\" \"npm run test:sh\" \"npm run test:go\"",
-    "test:sh": "npx bats test/",
-    "test:go": "make test",
-    "prepare": "make install",
+    "prepare": "node scripts/install.js",
+    "build": "node scripts/build.js",
+    "build:platform": "node scripts/build-platform.js",
+    "build:all": "node scripts/build-all.js",
+    "clean": "node scripts/clean.js",
+    "test": "npm run build && npx bats test/sync-agents.bats test/integration-global.bats",
+    "test:integration": "npm run build && npx bats test/integration-global.bats",
     "prepack": "node scripts/sync-optional-deps.js",
     "bootstrap:publish": "bash scripts/bootstrap-platform-publish.sh"
   },

package/src/md/RULE_TEMPLATE.md

@@ -1,6 +0,0 @@
-
----
-trigger: always_on
----
-
-# ${NAME}

package/src/md/SKILL_TEMPLATE.md

@@ -1,23 +0,0 @@
----
-trigger: always_on
----
-
-# ${NAME}
-
-## Description
-
-Brief description of what this skill enables.
-
-## Usage
-
-When to use this skill and how to invoke it.
-
-## Examples
-
-```
-Example usage or invocation here.
-```
-
-## Notes
-
-Any caveats, prerequisites, or related skills.

package/src/md/STATE_TEMPLATE.md

@@ -1,24 +0,0 @@
----
-trigger: always_on
----
-
-# State
-
-Track project progress, current objectives, and resumption context.
-Update this file regularly so agents can pick up where they left off.
-
-## Save location
-
-../STATE_${CONTEXT_DESCRIPTION}_YYYYMMDDHHMMSS.md
-
-A new file will be created each time during agent executions as a short summary of the current state, progress, blockers, and next steps. This allows for a historical record of the project's evolution and provides context for future agent executions. The timestamp in the filename helps to keep track of when each state was recorded, and the context description provides a quick reference to the specific project or objective being tracked. Lastly there should exist session information / session id so we can resume openclaw tui and or claude-code sessions with the relevant context and state information.
-
-Save both if necessary, but the state file is more important for tracking progress and providing context for future executions. The session information can be useful for resuming interactive sessions, but the state file is essential for maintaining a record of the project's evolution and providing context for future agent executions.
-
-## Format
-
-### YYYYMMDDHHMMSS STATE: <objective>
-
-Description of current state, progress, blockers, and next steps.
-
-Be sure to indicate whats left and what done via - [ ] checkboxes in state file

package/src/md/WORKFLOW_TEMPLATE.md

@@ -1,24 +0,0 @@
----
-trigger: always_on
----
-
-# ${NAME}
-
-## Trigger
-
-Describe when this workflow should be activated.
-
-## Steps
-
-1. Step one
-2. Step two
-3. Step three
-
-## Conditions
-
-- Pre-conditions that must be met
-- Any guards or checks
-
-## Output
-
-What the workflow produces or changes when complete.