snaplogic slpy

Install and manage the slpy using the snaplogic CLI.

Prerequisites

  • You must be signed in. Run snaplogic auth status to confirm your sign-in is active.
  • uv must be on your PATH. The snaplogic CLI never installs uv itself. Refer to Install uv.
  • Python 3.12 must be installed on your machine (from python.org or your package manager). uv uses it for slpy's own environment and is not allowed to download a Python version.

snaplogic slpy install

Installs slpy via uv. Nothing is changed on disk until your login, and the Org/Environment, and the package index have been checked. The slpy and pcc commands are placed next to the snaplogic binary if that directory is writable and on PATH; otherwise they go into uv's tools bin directory (uv tool dir --bin). Once installed, invoke slpy directly (slpy --help), not through snaplogic slpy.

snaplogic slpy install [--version V] [--bin-dir DIR] [--org NAME] [--max-age DUR] [--json]
Flag Description
--version V Installs a specific release instead of the current one.
--bin-dir DIR Directory for the slpy and pcc commands. Defaults to the directory containing snaplogic if that directory is on PATH, otherwise the uv tools bin directory.
--org NAME Org/Environment to use for this run. Overrides SNAPLOGIC_ORG_NAME and the Orgs/Environments recorded at sign-in.
--max-age DUR Skips the install if slpy was already installed within the given duration (for example, --max-age 24h). Without this flag, install always reinstalls.
--json Prints output as JSON. Errors go to stderr as {"error": "<message>"}.

snaplogic slpy upgrade

It always reinstalls the current release of slpy. Equivalent to snaplogic slpy install without --max-age.

snaplogic slpy upgrade [--bin-dir DIR] [--org NAME] [--json]
Flag Description
--bin-dir DIR Directory containing the slpy and pcc commands to upgrade.
--org NAME Org/Environment to use for this run. Overrides SNAPLOGIC_ORG_NAME and the Org/Environment recorded at sign-in.
--json Prints output as JSON. Errors go to stderr as {"error": "<message>"}.

snaplogic slpy status

Shows where slpy and pcc are installed. If that directory is not on your PATH, the command displays how to add it (or run uv tool update-shell).

snaplogic slpy status [--json]
Flag Description
--json Prints output as JSON. Errors go to stderr as {"error": "<message>"}.

snaplogic slpy uninstall

It runs uv tool uninstall slpy, removing slpy and both commands (slpy and pcc). The uv installation and its Python version are not affected. Exits 0 if nothing is installed.

snaplogic slpy uninstall [--bin-dir DIR] [--json]
Flag Description
--bin-dir DIR Directory containing the commands to remove.
--json Prints output as JSON. Errors go to stderr as {"error": "<message>"}.

Exit codes

  • 0: Success, including empty results and nothing to uninstall
  • 1: API error, or a usage error (bad flags, too many arguments)
  • 2: Missing or invalid configuration