pi-git-sync

Keep your Pi setup with you, wherever you work.

📖 中文文档

---

Your Setup, Wherever You Work

Connect a private GitHub repository once and let it carry your Pi configuration between machines. Your extensions, skills, prompts, themes, settings, and agent instructions stay together in one place.

The first machine captures what you already use. On another machine, point pi-git-sync at the same repository and pick up from there. Run /pisync on any device for the complete sync: remote changes are pulled first, then local changes are captured and pushed.

Behind the scenes, pi-git-sync keeps every synced item under sync/. It compares the last synced state with local and remote changes, then stops for your review when the same file changed in two places.

---

Get Started

Before You Begin

• Pi 0.82.1 or newer (Node.js >=22.19.0)
• Git + SSH configured (for GitHub)

1. Create a Private Repo

Create an empty private repository on GitHub (any name you like). Leave Initialize with README unchecked.

2. Install pi-git-sync on Your First Machine

pi install npm:@jachy/pi-git-sync

The config repository is user data, not a Pi package. Do not run pi install on the config repository itself.

3. Connect Your First Machine

Run /pisync in Pi. When prompted, enter your repository URL. For an empty repository, pi-git-sync uses this machine as the starting point: it creates the configuration structure, captures your current configuration (including settings.json and its packages[]), then commits and pushes it to the repository.

Generated repo structure:

<your-repo>/
├── .gitignore
├── pi-sync.json              # Sync configuration
└── sync/                     # All synced content lives here
    ├── settings.json          # Shared settings (whole file)
    ├── AGENTS.md              # (optional)
    ├── SYSTEM.md              # (optional)
    ├── APPEND_SYSTEM.md       # (optional)
    ├── keybindings.json       # (optional)
    ├── extensions/            # Custom extensions
    ├── skills/                # Skills
    ├── prompts/               # Prompt templates
    └── themes/                # Themes

Bring a New Machine Onboard

Install pi-git-sync, then run /pisync and enter your existing repository URL when prompted. pi-git-sync fetches the repository and applies its configuration to that Pi installation.

Share Later Changes

After changing your configuration, run:

/pisync

The command pulls remote changes first, then captures and pushes local changes. While it runs, the status line shows elapsed time. Press Esc to cancel and terminate active Git/SSH subprocesses; a run is also stopped automatically after 60 seconds. The pullTimeoutMs setting controls each pull, fetch, and rebase operation within that limit. If package changes need approval, pi-git-sync pauses before applying them and resumes after approval. Older generated settings placeholders with an empty sync baseline are recognized and calibrated without copying files.

---

Commands

Command	Description
/pisync	Set up or run complete pull-then-push sync
/pisync status	Show detailed sync status (three-way comparison + git info)
/pisync diff	Show pending changes between agent and repo

---

What Gets Synced

Content	Method
Extensions	Copied from sync/extensions/ into agent directory
Skills	Copied from sync/skills/ into agent directory
Prompts	Copied from sync/prompts/ into agent directory
Themes	Copied from sync/themes/ into agent directory
settings.json	Whole-file copy (no key-level merge)
AGENTS.md, SYSTEM.md, APPEND_SYSTEM.md	Copied into agent directory
keybindings.json	Copied into agent directory
Third-party Packages	Declared in sync/settings.json → packages[]; new or changed sources require approval before installation (local-only packages are never auto-removed)

What Never Gets Synced

Hard deny list (built-in, not configurable):

auth.json, sessions/**, trust.json, models-store.json, npm/**, git/**, node_modules/**, .pi-sync/**, **/.env, **/*.pem, **/id_rsa, **/id_ed25519

Also: hidden files (except .gitignore) are excluded. Symlinks and symlink components are blocked with an error; they are never followed or silently skipped.

---

Config Reference (pi-sync.json)

{
  "schemaVersion": 2,
  "branch": "main",
  "root": "sync",
  "include": [
    "settings.json",
    "AGENTS.md",
    "SYSTEM.md",
    "APPEND_SYSTEM.md",
    "keybindings.json",
    "extensions/**",
    "skills/**",
    "prompts/**",
    "themes/**"
  ],
  "exclude": [
    "**/.DS_Store",
    "**/*.tmp",
    "**/*.log"
  ],
  "delete": "tracked",
  "pullTimeoutMs": 10000,
  "security": {
    "scanSecretsBeforePush": true
  }
}

Fields

Field	Type	Default	Description
schemaVersion	2	—	Config schema version (currently 2)
branch	string	"main"	The single Git branch used by setup, status, sync, and rebase
root	string	"sync"	Root directory inside the repo for synced content
include	string[]	—	Glob whitelist (relative to root). Supports *, **, ?
exclude	string[]	[]	Glob patterns to exclude (lower priority than built-in hard deny)
delete	"tracked" | "none"	"tracked"	"tracked": delete agent files when removed from repo. "none": never delete
pullTimeoutMs	number	10000	Timeout for pull/fetch/rebase Git operations in milliseconds; a timeout kills the Git/SSH process tree, stops the sync, and returns control to Pi
security.scanSecretsBeforePush	boolean	true	Scan staged files for secrets (API keys, tokens, private keys) before pushing

---

Sync Model

Three-Way Comparison

Every sync operation compares three states:

B = Baseline (last synced commit hash)  — stored in `<config-repo>/.pi-sync/state.json` (Git ignored)
L = Local   (current agent files)
R = Remote  (current repo sync/ files)

This gives accurate detection of:

Scenario	Classification	Action
Only you changed a file	local_only	Captured on push
Only remote changed a file	remote_only	Applied on pull
Both changed the same file differently	both_modified	Blocked — resolve manually
You created a new file	local_created	Captured on push
Remote created a new file	remote_created	Applied on pull
You deleted a tracked file	local_deleted	Captured on push
Remote deleted a tracked file	remote_deleted	Applied on pull (if delete: "tracked")
Both made the same change	converged	Baseline updated, no conflict

Push Flow

capture (agent → repo working tree)
  → commit
  → fetch origin
  → rebase onto origin/<configured branch>
  → push <configured branch>
  → push current-device snapshot branch
  → apply (new HEAD → agent)

Each device has one persistent, unique remote snapshot branch: pisync-device/<hostname>-<UUID>. A hostname is not unique; the UUID is stored only in <config-repo>/.pi-sync/state.json. That directory is Git-ignored and never synced. The tool therefore never scans remote branches and guesses a “unique device branch.”

On conflict, pi-git-sync pushes current-device changes to that device branch and restores the configured branch to the remote configured branch. It then automatically merges the device branch and pushes the result whenever Git can merge it cleanly. Only a real content conflict or a concurrent remote update requires manual resolution:

cd <sync-repository>
git fetch origin
git switch <configured-branch>
git merge origin/pisync-device/<hostname>-<UUID>
# resolve conflicts, then
git add <files>
git commit
git push origin <configured-branch>

Pull Flow

fetch origin
  → check for local un-captured changes (block if any)
  → fast-forward only (block if diverged)
  → apply (new HEAD → agent)

---

Safety

• Pull uses fast-forward only; stops on divergence
• Bilateral conflict detection — automatically fast-forwards or cleanly merges a current-device branch; only content conflicts or concurrent remote updates require manual resolution
• Automatic secret scanning before push (API keys, tokens, private keys)
• Atomic config writes (temp file → rename)
• Automatic backup before every apply, with fail-closed rollback support
• Concurrency lock prevents multiple Pi instances from syncing simultaneously
• Built-in hard deny list prevents syncing credentials (not user-overridable)
• Repo and agent path-boundary checks block symlink escapes
• Remote package additions and changes require explicit approval; failed installs attempt package rollback
• Settings.json portability validation — warns about absolute paths and machine-specific content

---

Development

Local Debugging

Symlink into Pi extensions directory:

ln -s $(pwd) ~/.pi/agent/extensions/pi-git-sync

Then /reload in Pi to pick up changes.

Or load temporarily via -e (does not write to settings.json):

pi -e ./index.ts

Run Tests

npm install
npm test           # unit/integration suite
npm run test:ci    # typecheck + coverage + E2E
npm run test:watch # watch mode
npm run typecheck  # type check
npm audit --omit=dev --audit-level=high
npm audit --audit-level=high

Upgrade Notes

When upgrading from 0.2.x (or an older compatible state), keep the existing config repository and run /pisync. The local sync state migrates from schema v2 to v3 after backing up the old state. Equal local/repo files are reconciled; conflicting files are preserved and reported instead of choosing a side. The v0.3 command set removes the old write subcommands; use /pisync for setup and complete synchronization, and /pisync status or /pisync diff for inspection.

See the full upgrade guide.

Project Structure

pi-git-sync/
├── index.ts              # Extension entry point
├── package.json
├── tsconfig.json
├── scripts/
│   └── bootstrap.sh      # Bootstrap script for new machines
├── src/
│   ├── commands.ts        # /pisync command routing + unified sync flow
│   ├── config.ts          # pi-sync.json loading & validation
│   ├── git.ts             # Git operations (status, fetch, fast-forward, push, rebase)
│   ├── inventory.ts       # Three-way file comparison (baseline vs local vs remote)
│   ├── materialize.ts     # Apply repo files to agent (atomic writes, validation)
│   ├── capture.ts         # Import agent changes into repo working tree
│   ├── backup.ts          # Backup & rollback
│   ├── lock.ts            # Concurrency lock (pid-based with staleness detection)
│   ├── security.ts        # Built-in hard deny list & secret scanning
│   ├── validate.ts        # File content validation (JSON, conflict markers, portability)
│   ├── state.ts           # Sync state persistence (baseline)
│   ├── packages.ts        # Package reconciliation (settings.json packages[])
│   ├── settings.ts        # Utility functions (deepMerge, deepEqual — legacy)
│   ├── glob.ts            # Custom minimatch glob + hard deny + path filtering
│   └── ui.ts              # Output formatting
└── test/
    ├── config.test.ts
    ├── git.test.ts
    ├── lock.test.ts
    ├── materialize.test.ts
    ├── minimatch.test.ts
    ├── packages.test.ts
    ├── security.test.ts
    └── settings.test.ts

Publishing

npm run pub        # patch version
npm run pub:minor  # minor version
npm run pub:major  # major version

Type checking and tests run automatically before publish. A git tag is created after publish.

---

License

MIT