SF CLI plugin for Veles — set up Veles on an existing scratch org or sandbox and connect it to your Veles Hub.
sf plugins install @beyondthecloud/sf-velesNote: This command does not create scratch orgs or sandboxes. The target org must already exist and be authorized with the Salesforce CLI before running
sf veles setup. For sandboxes, anEnvironment__crecord for that sandbox must also already exist on the Hub.
sf veles setup --target-org <scratch-or-sandbox> [--target-dev-hub <hub>] [--group <name>] [--installation-key <key>]- Provisions the org on your Veles Hub (creates Environment record + connection token)
- Installs the Veles managed package (if not already present)
- Deploys Remote Site Settings for Hub communication
- Configures the connection metadata
- Connects the org to the Hub
# Set up Veles on an existing scratch org (uses default DevHub)
sf veles setup --target-org my-scratch
# Set up Veles on an existing scratch org with explicit DevHub and group
sf veles setup --target-org my-scratch --target-dev-hub my-hub --group MyGroup
# Set up Veles on an existing sandbox with explicit Hub
sf veles setup --target-org my-sandbox --target-dev-hub my-hub
# With package installation key
sf veles setup --target-org my-scratch --installation-key MyKey123| Flag | Alias | Required | Description |
|---|---|---|---|
--target-org |
-o |
Yes | Already-created and authorized scratch org or sandbox to set up |
--target-dev-hub |
-v |
No | Hub/DevHub org (defaults to SF CLI default) |
--group |
-g |
No | Environment group name on the Hub |
--installation-key |
-k |
No | Installation key for the Veles package |
- The target org must already be created and authorized via the Salesforce CLI. This command does not create scratch orgs or sandboxes.
- Salesforce CLI installed
- Veles managed package installed on your Hub org
- Authenticated to both the target org and Hub/DevHub
- For sandboxes: an
Environment__crecord for the sandbox must already exist on the Hub
MIT