CLI

The plugsync CLI manages your connectors like code: pull a connector’s configuration to a local directory, edit it in your editor, diff it against what’s deployed, validate it, preview a publish, and push it back. It’s also the authoring surface for plugins. Everything goes through the same API the dashboard uses.

Install

pip install plugsync-cli

Requires Python 3.12+. The package is on PyPI as plugsync-cli and releases independently of the platform.

Quickstart

plugsync auth login -e [email protected]
plugsync pull my-connector

api_url defaults to the hosted platform (https://app.plugsync.com), so there’s nothing to configure for the common case — plugsync config set api_url <url> is only needed to point the CLI elsewhere. plugsync auth login saves a credential to ~/.plugsync/config.yaml that every subsequent command reuses. For scripts and CI, use a long-lived org API key instead — create one in Settings → API Keys, then either plugsync auth login --token ps_org_... or set the PLUGSYNC_API_KEY environment variable.

The workflow

plugsync pull my-connector      # download config as local YAML files
# ...edit plugsync.yaml / entities/*.yaml...
plugsync diff my-connector      # what changed vs. remote
plugsync validate my-connector  # schema check, no side effects
plugsync preview my-connector   # what a publish would change
plugsync push my-connector      # upload to the connector's draft

push writes to the connector’s draft, exactly like editing in the dashboard or via the AI agent — publishing stays a deliberate, separate step, so nothing goes live by accident. plugsync log shows revision history and plugsync rollback restores a previous revision into the draft.

Commands

Command	Purpose
`plugsync auth login` / `logout`	Authenticate (email/password, or `--token` with an org API key)
`plugsync config set/get/show`	Manage local CLI configuration
`plugsync pull <name>`	Download a connector as a local directory
`plugsync push <name>`	Upload a local connector directory to the draft
`plugsync diff <name>`	Diff local files vs. remote working state
`plugsync validate <name>`	Validate a local connector config
`plugsync preview <name>`	Preview a publish’s effects
`plugsync log <name>`	Show a connector’s revision history
`plugsync rollback <name>`	Restore a previous revision
`plugsync plugin ...`	Author and manage plugins (Enterprise tier)

Run plugsync --help or plugsync <command> --help for the full option list.

Plugins

plugsync plugin init/push/status/logs/metrics/invoke/promote/publish/rollback covers the whole plugin lifecycle: scaffold locally, push to a per-developer sandbox, test, then promote through staging to live. You never need AWS credentials — every deployment happens server-side. Plugin commands require an Enterprise plan; the connector workflow above is available on every tier.

Compatibility

The CLI checks the API’s version at the start of every command and warns — never fails — if the API is older than the CLI expects. Pin a version in CI with pip install plugsync-cli==X.Y.Z.