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, diff against the remote, validate, preview a publish, and manage plugins -- all without cloning the plugsync backend repo.

Install

pip install plugsync-cli

Requires Python 3.12+.

Quickstart

plugsync config set api_url https://your-plugsync-instance.example.com
plugsync auth login -e you@example.com
plugsync pull my-connector

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 as a local directory
plugsync push <name> Upload a local connector directory
plugsync diff <name> Diff local 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 init/push/list/status/logs/invoke 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.1.0.tar.gz (30.8 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.1.0-py3-none-any.whl (28.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: plugsync_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 30.8 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.1.0.tar.gz
Algorithm Hash digest
SHA256 f3263492a0fef4034ddda62de1f0b1267ef0a45e642114c4b3d548cdcde11a00
MD5 f3e5eddc39bf83b93d9935c281fc7fe8
BLAKE2b-256 5ef15b2ecd2c1ae093afbe52174f30109954b038a8c64ef2d8af24116d31636c

See more details on using hashes here.

Provenance

The following attestation bundles were made for plugsync_cli-0.1.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.1.0-py3-none-any.whl.

File metadata

  • Download URL: plugsync_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 28.3 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a86e9b192b562b338a8fc4f188f8e3e584a94379eaade592ebc1bd9cbc1be11a
MD5 4349131a026283e69296189d2adc2f35
BLAKE2b-256 407d7aa3e532053b0885b4bf80b9f08caf03907df8f321fe1da1fdccbc647ec5

See more details on using hashes here.

Provenance

The following attestation bundles were made for plugsync_cli-0.1.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