Skip to content
OpenPlanr Docs
LearnGitHub (opens in a new tab)

openplanr sync

Validate and fix cross-references across all artifacts

Usage
openplanr sync [options] [command]
Options for openplanr sync
OptionDescription
--dry-run

show what would change without writing files

Commands

  • tracker

    Inspect a tracker, or preview and apply GitHub issue changes through gh

openplanr sync tracker

Inspect a tracker, or preview and apply GitHub issue changes through gh

Usage
openplanr sync tracker [options] <provider> <action>
Arguments for openplanr sync tracker
ArgumentDescription
providerRequired

local or github (Linear uses the coding agent's connection)

actionRequired

inspect or sync

Options for openplanr sync tracker
OptionDescription
--input <path>

JSON array of GitHub issue operations; - reads stdin

--apply

run the operations; without it, sync only previews

Default: false

--json

machine-readable output

Default: false

Notes

Operations (--input, a JSON array):
  {"action":"create","title":"...","body":"...","labels":["..."]}
  {"action":"update","id":"12","title":"...","body":"...","labels":["..."]}
  {"action":"close","id":"12","comment":"..."}
  {"action":"reopen","id":"12","comment":"..."}
  "id" is an issue number or an issue URL in the repository gh resolves.
  update only adds "labels"; it never removes one. Without --apply, sync only previews.

gh runs with an allowlisted environment: its own GH_*/GITHUB_* host and token
variables, PATH, home, locale, proxy and CA settings. Other variables never reach it.

Examples:
  openplanr sync tracker github inspect --json
  openplanr sync tracker github sync --input ops.json --json
  openplanr sync tracker github sync --input - --apply --json < ops.json
  openplanr sync tracker local inspect