Skip to main content

Command-line client for plugsync HubSpot connectors -- manage connectors and plugins like code, no repo checkout required

Project description

plugsync-cli

Command-line client for plugsync, managing HubSpot connectors like code: pull a connector's config to a local directory, edit it, push it back to the draft, diff against a published version, validate, preview a publish, and manage plugins -- all without cloning the plugsync backend repo.

push writes the draft and stops. Publishing is opt-in (push --publish), so a config never reaches production as a side effect of saving a file.

Install

pip install plugsync-cli

Requires Python 3.12+.

Quickstart

plugsync auth login -e you@example.com
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. Point it elsewhere with plugsync config set api_url <url>. plugsync auth login saves a bearer credential to ~/.plugsync/config.yaml that every subsequent command reuses. PLUGSYNC_API_URL / PLUGSYNC_API_KEY environment variables override the config file, handy for CI.

Commands

Command Purpose
plugsync auth login / logout Authenticate (email/password JWT, or a long-lived org API key with --token)
plugsync config set/get/show Manage ~/.plugsync/config.yaml
plugsync pull <name> Download a connector's draft as a local directory (--revision N for a published version)
plugsync push <name> Upload a local connector directory to the draft (--publish to also publish)
plugsync diff <name> Diff local files vs. a published version
plugsync validate <name> Preflight the draft; non-zero exit on an error
plugsync preview <name> Preview a publish's effects and its preflight findings
plugsync log <name> Show a connector's published version history
plugsync rollback <name> Restore a published version into the draft
plugsync plugin init/push/list/status/logs/metrics/invoke/promote/publish/rollback Author and manage plugins (Enterprise tier)

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

Compatibility

This CLI ships on its own release cadence, independent of the plugsync backend. It declares the minimum API version it expects and checks it against the API at the start of any command that talks to it, warning (never failing outright) if the API is older than expected.

Documentation

Full reference docs, including the plugin authoring dev-loop, live at docs.plugsync.com and in the plugsync repository.

License

Proprietary. This CLI talks to the plugsync SaaS API; see plugsync.com/terms for the terms governing use of the plugsync service.

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

plugsync_cli-0.3.0.tar.gz (55.9 kB view details)

Uploaded Source

Built Distribution

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

plugsync_cli-0.3.0-py3-none-any.whl (38.0 kB view details)

Uploaded Python 3

File details

Details for the file plugsync_cli-0.3.0.tar.gz.

File metadata

  • Download URL: plugsync_cli-0.3.0.tar.gz
  • Upload date:
  • Size: 55.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for plugsync_cli-0.3.0.tar.gz
Algorithm Hash digest
SHA256 4ee5496dd61cd8d25ee3b927e9d08552b15f6c31af883f79c74374c48e4c39c4
MD5 a84b20544d227e7c06e2f1136941fe22
BLAKE2b-256 053b681607cc649916b90c52fb1c90da3f24dfc784e9eb7d77c0bb988aa84ce4

See more details on using hashes here.

Provenance

The following attestation bundles were made for plugsync_cli-0.3.0.tar.gz:

Publisher: release-cli.yml on exelab/plugsync

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file plugsync_cli-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: plugsync_cli-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 38.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for plugsync_cli-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 282629b458b461a80035f55cbef42556d5e3eeebc178fb0768b5c3c6e785e735
MD5 dbd0a9807b3b08f4161317e0f663c0af
BLAKE2b-256 38c00c994b62967f2bb31efcc77cd684b5a347322422131f400695d4fa414ebd

See more details on using hashes here.

Provenance

The following attestation bundles were made for plugsync_cli-0.3.0-py3-none-any.whl:

Publisher: release-cli.yml on exelab/plugsync

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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