Skip to main content

Sync OpenCode agents and skills from an Obsidian vault to workspace directories

Project description

piagentsync

Sync OpenCode agents and skills from an Obsidian vault to workspace directories.

Install

uv add piagentsync
# or
pip install piagentsync

Quick start

  1. Initialize a new project in your vault:
piagentsync init myproject --workspace ~/workspace/myproject
  1. Pull the synced files to your workspace:
piagentsync pull myproject

Configuration

Environment variables (also configurable via .env file):

Variable Default Description
PIAGENTSYNC_VAULT_PATH ~/vault Path to Obsidian vault
PIAGENTSYNC_GLOBAL_OPENCODE_PATH ~/.config/opencode Path to global OpenCode config
PIAGENTSYNC_VAULT_GITHUB_USER Piwero GitHub username for vault repository (used in clone instructions)

CLI reference

piagentsync pull <project>

Sync a single project from vault to workspace.

Options:

  • --dry-run / --no-dry-run — preview changes without writing
  • --global / --no-global — also sync global agents
  • --all — sync all discovered projects

piagentsync status [project]

Show diff between vault and workspace.

Options:

  • --all — show status for all projects (default when no project given)

piagentsync init <project>

Scaffold a new project in the vault.

Options:

  • --workspace PATH — required, workspace directory
  • --notion-board-id TEXT — optional Notion DB ID
  • --notion-project-filter TEXT — optional Notion project filter (defaults to project slug)

piagentsync bootstrap

Bootstrap machine from an existing vault. This is a one‑time setup to configure OpenCode and install global agents.

Options:

  • --force — overwrite existing opencode.json if present

Steps performed:

  1. Verifies that the vault exists (PIAGENTSYNC_VAULT_PATH). If missing, prints a helpful git clone command.
  2. Writes {PIAGENTSYNC_GLOBAL_OPENCODE_PATH}/opencode.json with Notion and Obsidian MCPs and disables tool globs. Skips if file exists unless --force is used.
  3. Runs opencode mcp auth notion interactively to authenticate with Notion. If opencode is not on PATH, a warning is printed and the step is skipped.
  4. Copies {vault}/agents/global/chief-pm.md to {PIAGENTSYNC_GLOBAL_OPENCODE_PATH}/agents/chief-pm.md, overwriting if the content has changed.

All steps produce clear Rich output and non‑critical warnings. The command exits 1 only if the vault is missing or a file write fails.

--version

Print version and exit.

AGENTS.md manifest format

Each project must have an AGENTS.md file in its root with YAML frontmatter:

---
project: myproject
workspace: ~/workspace/myproject
notion_board_id: 3305f9479a8d8055b3c3e86a9006cf91
notion_project_filter: myproject
---

The body below the frontmatter is the OpenCode routing table.

Expected vault structure

vault/
├── agents/
│   └── global/
│       └── *.md
└── projects/
    └── {project}/
        ├── AGENTS.md           # manifest with frontmatter
        ├── context.md          # optional context file
        ├── decisions.md        # optional decisions log
        ├── agents/
        │   └── *.md
        └── skills/
            └── *.md

Contributing

Development setup:

uv sync
uv run pytest

Lint and format:

uv run ruff check src/ tests/
uv run ruff format src/ tests/

All commits follow Conventional Commits.

Publishing (maintainers)

This repository uses GitHub Actions for CI and automated releases.

One-time PyPI setup (trusted publisher)

  1. Enable OIDC on PyPI for the repository:

    • Publisher: GitHub Actions
    • Repository owner: Piwero
    • Repository name: piagentsync
    • Workflow filename: release.yml
    • Environment name: (leave blank)
  2. The Release workflow handles everything: bump version, create tag, build, publish to PyPI, and create a GitHub Release.

Release process

git push → ci.yml passes
   → trigger release.yml (choose MAJOR/MINOR/PATCH/RC)
       → tests re-run → changelog generated → version bumped → tag pushed
       → GitHub Release created with assets → package published to PyPI

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

piagentsync-0.2.2rc1.tar.gz (51.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

piagentsync-0.2.2rc1-py3-none-any.whl (13.6 kB view details)

Uploaded Python 3

File details

Details for the file piagentsync-0.2.2rc1.tar.gz.

File metadata

  • Download URL: piagentsync-0.2.2rc1.tar.gz
  • Upload date:
  • Size: 51.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.2 {"installer":{"name":"uv","version":"0.11.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for piagentsync-0.2.2rc1.tar.gz
Algorithm Hash digest
SHA256 41828e5aac8fa5a8a6944af1c4d21a10acea9d37e9e48f2c063934cd1770a911
MD5 7cc0a2896aec4c572aa7aad2a6abc43e
BLAKE2b-256 8a7030e22028950ecd50bb2ebbb3cb1a8e1fb8f64c49c209452554916dbcaf1b

See more details on using hashes here.

File details

Details for the file piagentsync-0.2.2rc1-py3-none-any.whl.

File metadata

  • Download URL: piagentsync-0.2.2rc1-py3-none-any.whl
  • Upload date:
  • Size: 13.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.2 {"installer":{"name":"uv","version":"0.11.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for piagentsync-0.2.2rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 a86225af170ee8b98ebd4ecba4728c4bf631710e0af0062381a9430fb34e6096
MD5 ca20073b363794541043e307f6b3da4b
BLAKE2b-256 b278bf8cfdf28a9e877edd5442f2b2a9bb5ca300e811fddffffbb0d23586e3de

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page