Docs
flxbl.ioStatusContact us
codevsfp CLIsfp serverlibraries

Pool

Configure and monitor org pools

sfp server pool cleanup

Cleanup sandboxes from a pool being deleted. Deletes sandboxes that are >= 24 hours old from Salesforce. This command is typically run by Hatchet cleanup flows.

USAGE
  $ sfp server pool cleanup -r <value> -t <value> [--json] [-e <value>] [-t <value>] [--sfp-server-url <value>] [-g
    <value>...] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -e, --email=<value>               Email address for authenticated user. Ignored if --application-token is provided.
                                    Can be set via SFP_SERVER_USER env var.
  -g, --logsgroupsymbol=<value>...  Symbol used by CICD platform to group/collapse logs in the console. Provide an
                                    opening group, and an optional closing group symbol.
  -r, --repository=<value>          (required) Repository identifier in format owner/repo (GitHub/GitLab) or
                                    org/project/repo (Azure DevOps)
  -t, --application-token=<value>   Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN env var
                                    (CLI flags take precedence over env vars).
  -t, --tag=<value>                 (required) Pool tag to cleanup
      --loglevel=<option>           [default: info] logging level for this command invocation
                                    <options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
      --sfp-server-url=<value>      URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                    config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Cleanup sandboxes from a pool being deleted. Deletes sandboxes that are >= 24 hours old from Salesforce. This command
  is typically run by Hatchet cleanup flows.

EXAMPLES
  $ sfp server pool cleanup --repository myorg/myrepo --tag dev_pool

  $ sfp server pool cleanup --repository myorg/myrepo --tag dev_pool --json

See code: src/commands/server/pool/cleanup.ts

sfp server pool config create

Create a new sandbox pool configuration

USAGE
  $ sfp server pool config create -r <value> -n <value> -t <value> --dev-hub-username <value> [--json] [-e <value>] [-t
    <value>] [--sfp-server-url <value>] [-g <value>...] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] [--sandbox-def-file <value>] [--source-sandbox
    <value>] [--branch-pattern <value>] [--min-instances <value>] [--max-instances <value>] [--days-keep-available
    <value>] [--refresh-strategy AUTO_REFRESH_EXPIRED|DELETE_EXPIRED|FLAG_EXPIRED|NOTIFY_ONLY] [--active]
    [--default-expiration-hours <value>] [--extended-expiration-hours <value>] [--avg-creation-time <value>]
    [--users-to-activate <value>...] [--post-creation-script <value>] [--data-seed-plan <value>]
    [--return-to-pool-on-unassign]

FLAGS
  -e, --email=<value>                      Email address for authenticated user. Ignored if --application-token is
                                           provided. Can be set via SFP_SERVER_USER env var.
  -g, --logsgroupsymbol=<value>...         Symbol used by CICD platform to group/collapse logs in the console. Provide
                                           an opening group, and an optional closing group symbol.
  -n, --name=<value>                       (required) Display name for the pool
  -r, --repository=<value>                 (required) Repository identifier in format owner/repo (GitHub/GitLab) or
                                           org/project/repo (Azure DevOps)
  -t, --application-token=<value>          Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN
                                           env var (CLI flags take precedence over env vars).
  -t, --tag=<value>                        (required) Unique tag identifier for the pool
      --active                             Whether the pool should be active immediately
      --avg-creation-time=<value>          [default: 30] Average time in minutes to create a sandbox
      --branch-pattern=<value>             Git branch pattern to associate with this pool (e.g., feature/*)
      --data-seed-plan=<value>             Path to data seed plan file
      --days-keep-available=<value>        [default: 3] Days to keep unassigned available sandboxes
      --default-expiration-hours=<value>   [default: 24] Default hours before a sandbox expires
      --dev-hub-username=<value>           (required) Username or alias of the Dev Hub to use for sandbox creation
      --extended-expiration-hours=<value>  [default: 72] Hours to extend when extension is requested
      --loglevel=<option>                  [default: info] logging level for this command invocation
                                           <options:
                                           trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
      --max-instances=<value>              [default: 10] Maximum total instances allowed in the pool
      --min-instances=<value>              [default: 3] Minimum number of available instances to maintain
      --post-creation-script=<value>       Path to script to run after sandbox creation
      --refresh-strategy=<option>          [default: AUTO_REFRESH_EXPIRED] Strategy for handling expired sandboxes
                                           <options: AUTO_REFRESH_EXPIRED|DELETE_EXPIRED|FLAG_EXPIRED|NOTIFY_ONLY>
      --return-to-pool-on-unassign         When true, unassigned sandboxes return to pool as AVAILABLE with reset timer.
                                           When false (default), they are marked as EXPIRED
      --sandbox-def-file=<value>           Path to the sandbox definition file
      --sfp-server-url=<value>             URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                           config:set server-url
      --source-sandbox=<value>             Name of the source sandbox to clone from
      --users-to-activate=<value>...       List of user emails to activate in each sandbox

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Create a new sandbox pool configuration

EXAMPLES
  $ sfp server pool config create --repository myorg/myrepo --name "Development Pool" --tag dev_pool --dev-hub-username devhub@mycompany.com --min-instances 3 --max-instances 10

  $ sfp server pool config create --repository myorg/myrepo --name "CI Pool" --tag ci_pool --dev-hub-username devhub@mycompany.com --sandbox-def-file config/project-scratch-def.json --source-sandbox SOURCE_SB

See code: src/commands/server/pool/config/create.ts

sfp server pool config delete

Delete a sandbox pool configuration and all its sandboxes

USAGE
  $ sfp server pool config delete -r <value> -t <value> [--json] [-e <value>] [-t <value>] [--sfp-server-url <value>] [-g
    <value>...] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] [--no-confirm]

FLAGS
  -e, --email=<value>               Email address for authenticated user. Ignored if --application-token is provided.
                                    Can be set via SFP_SERVER_USER env var.
  -g, --logsgroupsymbol=<value>...  Symbol used by CICD platform to group/collapse logs in the console. Provide an
                                    opening group, and an optional closing group symbol.
  -r, --repository=<value>          (required) Repository identifier in format owner/repo (GitHub/GitLab) or
                                    org/project/repo (Azure DevOps)
  -t, --application-token=<value>   Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN env var
                                    (CLI flags take precedence over env vars).
  -t, --tag=<value>                 (required) Pool tag to delete
      --loglevel=<option>           [default: info] logging level for this command invocation
                                    <options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
      --no-confirm                  Skip confirmation prompt
      --sfp-server-url=<value>      URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                    config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Delete a sandbox pool configuration and all its sandboxes

EXAMPLES
  $ sfp server pool config delete --repository myorg/myrepo --tag dev_pool

  $ sfp server pool config delete --repository myorg/myrepo --tag dev_pool --no-confirm

See code: src/commands/server/pool/config/delete.ts

sfp server pool config get

Get details of a specific sandbox pool configuration

USAGE
  $ sfp server pool config get -r <value> -t <value> [--json] [-e <value>] [-t <value>] [--sfp-server-url <value>] [-g
    <value>...] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -e, --email=<value>               Email address for authenticated user. Ignored if --application-token is provided.
                                    Can be set via SFP_SERVER_USER env var.
  -g, --logsgroupsymbol=<value>...  Symbol used by CICD platform to group/collapse logs in the console. Provide an
                                    opening group, and an optional closing group symbol.
  -r, --repository=<value>          (required) Repository identifier in format owner/repo (GitHub/GitLab) or
                                    org/project/repo (Azure DevOps)
  -t, --application-token=<value>   Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN env var
                                    (CLI flags take precedence over env vars).
  -t, --tag=<value>                 (required) Pool tag to retrieve
      --loglevel=<option>           [default: info] logging level for this command invocation
                                    <options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
      --sfp-server-url=<value>      URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                    config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Get details of a specific sandbox pool configuration

EXAMPLES
  $ sfp server pool config get --repository myorg/myrepo --tag dev_pool

See code: src/commands/server/pool/config/get.ts

sfp server pool config list

List all sandbox pool configurations

USAGE
  $ sfp server pool config list [--json] [-r <value>] [-e <value>] [-t <value>] [--sfp-server-url <value>] [-g <value>...]
    [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -e, --email=<value>               Email address for authenticated user. Ignored if --application-token is provided.
                                    Can be set via SFP_SERVER_USER env var.
  -g, --logsgroupsymbol=<value>...  Symbol used by CICD platform to group/collapse logs in the console. Provide an
                                    opening group, and an optional closing group symbol.
  -r, --repository=<value>          Filter by repository identifier in format owner/repo (GitHub/GitLab) or
                                    org/project/repo (Azure DevOps)
  -t, --application-token=<value>   Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN env var
                                    (CLI flags take precedence over env vars).
      --loglevel=<option>           [default: info] logging level for this command invocation
                                    <options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
      --sfp-server-url=<value>      URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                    config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List all sandbox pool configurations

EXAMPLES
  $ sfp server pool config list

  $ sfp server pool config list --repository myorg/myrepo

See code: src/commands/server/pool/config/list.ts

sfp server pool config push

Push a scratch org pool configuration from a local file to the server

USAGE
  $ sfp server pool config push -r <value> -f <value> --dev-hub-username <value> --branch <value> [--json] [-e <value>] [-t
    <value>] [--sfp-server-url <value>] [-g <value>...] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] [-n <value>] [--min-instances <value>]
    [--default-expiration-hours <value>]

FLAGS
  -e, --email=<value>                     Email address for authenticated user. Ignored if --application-token is
                                          provided. Can be set via SFP_SERVER_USER env var.
  -f, --config-file=<value>               (required) [default: config/poolconfig.json] Path to the pool configuration
                                          file (poolconfig.json)
  -g, --logsgroupsymbol=<value>...        Symbol used by CICD platform to group/collapse logs in the console. Provide an
                                          opening group, and an optional closing group symbol.
  -n, --name=<value>                      Display name for the pool (defaults to pool tag)
  -r, --repository=<value>                (required) Repository identifier in format owner/repo
  -t, --application-token=<value>         Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN
                                          env var (CLI flags take precedence over env vars).
      --branch=<value>                    (required) Git branch this pool targets
      --default-expiration-hours=<value>  Default hours before an assigned scratch org expires
      --dev-hub-username=<value>          (required) Username or alias of the Dev Hub to use
      --loglevel=<option>                 [default: info] logging level for this command invocation
                                          <options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
      --min-instances=<value>             Minimum available instances floor for replenishment
      --sfp-server-url=<value>            URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                          config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Push a scratch org pool configuration from a local file to the server

EXAMPLES
  $ sfp server pool config push -f config/poolconfig.json -r flxbl-io/sf-core --dev-hub-username devhub@example.com --branch main

  $ sfp server pool config push -f config/poolconfig.json -r flxbl-io/sf-core --dev-hub-username devhub --branch main --name "CI Pool" --min-instances 3

See code: src/commands/server/pool/config/push.ts

sfp server pool config update

Update an existing sandbox pool configuration

USAGE
  $ sfp server pool config update -r <value> -t <value> [--json] [-e <value>] [-t <value>] [--sfp-server-url <value>] [-g
    <value>...] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] [-n <value>]
    [--dev-hub-username <value>] [--sandbox-def-file <value>] [--source-sandbox <value>] [--branch-pattern <value>]
    [--min-instances <value>] [--max-instances <value>] [--days-keep-available <value>] [--refresh-strategy
    AUTO_REFRESH_EXPIRED|DELETE_EXPIRED|FLAG_EXPIRED|NOTIFY_ONLY] [--active] [--default-expiration-hours <value>]
    [--extended-expiration-hours <value>] [--avg-creation-time <value>] [--users-to-activate <value>...]
    [--post-creation-script <value>] [--data-seed-plan <value>] [--return-to-pool-on-unassign]

FLAGS
  -e, --email=<value>                      Email address for authenticated user. Ignored if --application-token is
                                           provided. Can be set via SFP_SERVER_USER env var.
  -g, --logsgroupsymbol=<value>...         Symbol used by CICD platform to group/collapse logs in the console. Provide
                                           an opening group, and an optional closing group symbol.
  -n, --name=<value>                       New display name for the pool
  -r, --repository=<value>                 (required) Repository identifier in format owner/repo (GitHub/GitLab) or
                                           org/project/repo (Azure DevOps)
  -t, --application-token=<value>          Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN
                                           env var (CLI flags take precedence over env vars).
  -t, --tag=<value>                        (required) Pool tag to update
      --[no-]active                        Set pool active status
      --avg-creation-time=<value>          New average creation time in minutes
      --branch-pattern=<value>             New Git branch pattern
      --data-seed-plan=<value>             New data seed plan path
      --days-keep-available=<value>        New days to keep unassigned available sandboxes
      --default-expiration-hours=<value>   New default expiration hours
      --dev-hub-username=<value>           New Dev Hub username or alias
      --extended-expiration-hours=<value>  New extended expiration hours
      --loglevel=<option>                  [default: info] logging level for this command invocation
                                           <options:
                                           trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
      --max-instances=<value>              New maximum total instances
      --min-instances=<value>              New minimum number of available instances
      --post-creation-script=<value>       New post creation script path
      --refresh-strategy=<option>          New strategy for handling expired sandboxes
                                           <options: AUTO_REFRESH_EXPIRED|DELETE_EXPIRED|FLAG_EXPIRED|NOTIFY_ONLY>
      --[no-]return-to-pool-on-unassign    When true, unassigned sandboxes return to pool as AVAILABLE. When false, they
                                           are marked as EXPIRED
      --sandbox-def-file=<value>           New path to the sandbox definition file
      --sfp-server-url=<value>             URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                           config:set server-url
      --source-sandbox=<value>             New source sandbox name
      --users-to-activate=<value>...       New list of users to activate

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Update an existing sandbox pool configuration

EXAMPLES
  $ sfp server pool config update --repository myorg/myrepo --tag dev_pool --min-instances 5 --max-instances 15

  $ sfp server pool config update --repository myorg/myrepo --tag dev_pool --active false

  $ sfp server pool config update --repository myorg/myrepo --tag dev_pool --refresh-strategy DELETE_EXPIRED

See code: src/commands/server/pool/config/update.ts

sfp server pool drain

Drop all sandbox/scratch-org instances from a pool by dispatching the cleanup Hatchet workflow with skipFinalize=true. The pool configuration is preserved so the pool can be replenished afterwards. Pass --tag all to drain every active pool in the repository (one workflow per pool).

USAGE
  $ sfp server pool drain -r <value> -t <value> [--json] [-e <value>] [-t <value>] [--sfp-server-url <value>] [-g
    <value>...] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -e, --email=<value>               Email address for authenticated user. Ignored if --application-token is provided.
                                    Can be set via SFP_SERVER_USER env var.
  -g, --logsgroupsymbol=<value>...  Symbol used by CICD platform to group/collapse logs in the console. Provide an
                                    opening group, and an optional closing group symbol.
  -r, --repository=<value>          (required) Repository identifier in format owner/repo (GitHub/GitLab) or
                                    org/project/repo (Azure DevOps)
  -t, --application-token=<value>   Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN env var
                                    (CLI flags take precedence over env vars).
  -t, --tag=<value>                 (required) Pool tag to drain, or 'all' to dispatch drain workflows for every active
                                    pool in the repository
      --loglevel=<option>           [default: info] logging level for this command invocation
                                    <options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
      --sfp-server-url=<value>      URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                    config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Drop all sandbox/scratch-org instances from a pool by dispatching the cleanup Hatchet workflow with skipFinalize=true.
  The pool configuration is preserved so the pool can be replenished afterwards. Pass --tag all to drain every active
  pool in the repository (one workflow per pool).

EXAMPLES
  $ sfp server pool drain --repository myorg/myrepo --tag dev_pool

  $ sfp server pool drain --repository myorg/myrepo --tag all

See code: src/commands/server/pool/drain.ts

sfp server pool monitor

Monitor a sandbox pool - reconcile states, activate sandboxes, process lifecycle, and provision if needed. This command is typically run by Hatchet scheduled jobs or manually for testing.

USAGE
  $ sfp server pool monitor -r <value> -t <value> [--json] [-e <value>] [-t <value>] [--sfp-server-url <value>] [-g
    <value>...] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] [--dry-run]

FLAGS
  -e, --email=<value>               Email address for authenticated user. Ignored if --application-token is provided.
                                    Can be set via SFP_SERVER_USER env var.
  -g, --logsgroupsymbol=<value>...  Symbol used by CICD platform to group/collapse logs in the console. Provide an
                                    opening group, and an optional closing group symbol.
  -r, --repository=<value>          (required) Repository identifier in format owner/repo (GitHub/GitLab) or
                                    org/project/repo (Azure DevOps)
  -t, --application-token=<value>   Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN env var
                                    (CLI flags take precedence over env vars).
  -t, --tag=<value>                 (required) Pool tag to monitor
      --dry-run                     Show what would be done without making any changes
      --loglevel=<option>           [default: info] logging level for this command invocation
                                    <options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
      --sfp-server-url=<value>      URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                    config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Monitor a sandbox pool - reconcile states, activate sandboxes, process lifecycle, and provision if needed. This
  command is typically run by Hatchet scheduled jobs or manually for testing.

EXAMPLES
  $ sfp server pool monitor --repository myorg/myrepo --tag dev_pool

  $ sfp server pool monitor --repository myorg/myrepo --tag dev_pool --dry-run

  $ sfp server pool monitor --repository myorg/myrepo --tag dev_pool --json

See code: src/commands/server/pool/monitor.ts

sfp server pool replenish

Trigger the pool replenishment Hatchet workflow for a single pool or every active pool (--tag all). The workflow performs reconciliation, lifecycle processing, and quota maintenance asynchronously.

USAGE
  $ sfp server pool replenish -r <value> -t <value> [--json] [-e <value>] [-t <value>] [--sfp-server-url <value>] [-g
    <value>...] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -e, --email=<value>               Email address for authenticated user. Ignored if --application-token is provided.
                                    Can be set via SFP_SERVER_USER env var.
  -g, --logsgroupsymbol=<value>...  Symbol used by CICD platform to group/collapse logs in the console. Provide an
                                    opening group, and an optional closing group symbol.
  -r, --repository=<value>          (required) Repository identifier in format owner/repo (GitHub/GitLab) or
                                    org/project/repo (Azure DevOps)
  -t, --application-token=<value>   Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN env var
                                    (CLI flags take precedence over env vars).
  -t, --tag=<value>                 (required) Pool tag to replenish, or 'all' to dispatch replenishment for every
                                    active pool in the repository
      --loglevel=<option>           [default: info] logging level for this command invocation
                                    <options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
      --sfp-server-url=<value>      URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                    config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Trigger the pool replenishment Hatchet workflow for a single pool or every active pool (--tag all). The workflow
  performs reconciliation, lifecycle processing, and quota maintenance asynchronously.

EXAMPLES
  $ sfp server pool replenish --repository myorg/myrepo --tag dev_pool

  $ sfp server pool replenish --repository myorg/myrepo --tag all

See code: src/commands/server/pool/replenish.ts

sfp server pool scratch init

Prepare a pool of scratchorgs with all the packages upfront, so that any incoming change can be validated in an optimized manner

USAGE
  $ sfp server pool scratch init [--json] [-r <value>] [-e <value>] [-t <value>] [--sfp-server-url <value>] [-p <value>]
    [--npmrcpath <value>] [--keys <value>] [-g <value>...] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -e, --email=<value>               Email address for authenticated user. Ignored if --application-token is provided.
                                    Can be set via SFP_SERVER_USER env var.
  -g, --logsgroupsymbol=<value>...  Symbol used by CICD platform to group/collapse logs in the console. Provide an
                                    opening group, and an optional closing group symbol.
  -p, --tag=<value>                 Pool tag to fetch config from server
  -r, --repository=<value>          Repository identifier (e.g., flxbl-io/sf-core). When provided, config is fetched
                                    from server.
  -t, --application-token=<value>   Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN env var
                                    (CLI flags take precedence over env vars).
      --keys=<value>                Keys to be used while installing any managed package dependencies. Required format
                                    is a string of key-value pairs separated by spaces e.g. packageA:pw123
                                    packageB:pw123 packageC:pw123
      --loglevel=<option>           [default: info] logging level for this command invocation
                                    <options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
      --npmrcpath=<value>           Path to .npmrc file used for authentication to a npm registry when using npm based
                                    artifacts. If left blank, defaults to home directory
      --sfp-server-url=<value>      URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                    config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Prepare a pool of scratchorgs with all the packages upfront, so that any incoming change can be validated in an
  optimized manner

ALIASES
  $ sfp prepare
  $ sfp pool prepare
  $ sfp pool scratch prepare
  $ sfp pool scratch init

EXAMPLES
  $ sfp server pool scratch init -p ci -r flxbl-io/sf-core

  $ sfp server pool scratch init -p ci -r flxbl-io/sf-core -v devhub@override.com

  $ sfp server pool scratch init -f config/mypoolconfig.json -v <devhub>

See code: src/commands/server/pool/scratch/init.ts

sfp server pool status

Get detailed status and statistics for a sandbox pool. When a specific pool tag is provided, instance details are shown by default.

USAGE
  $ sfp server pool status -r <value> [--json] [-e <value>] [-t <value>] [--sfp-server-url <value>] [-g <value>...]
    [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] [-t <value>] [-i] [--filter-status
    ERROR|ASSIGNED|AVAILABLE|PROVISIONING|ACTIVATING|EXPIRED|DELETING|ORPHANED]

FLAGS
  -e, --email=<value>               Email address for authenticated user. Ignored if --application-token is provided.
                                    Can be set via SFP_SERVER_USER env var.
  -g, --logsgroupsymbol=<value>...  Symbol used by CICD platform to group/collapse logs in the console. Provide an
                                    opening group, and an optional closing group symbol.
  -i, --[no-]instances              Show detailed instance information (default: true when tag is provided, use
                                    --no-instances to hide)
  -r, --repository=<value>          (required) Repository identifier in format owner/repo (GitHub/GitLab) or
                                    org/project/repo (Azure DevOps)
  -t, --application-token=<value>   Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN env var
                                    (CLI flags take precedence over env vars).
  -t, --tag=<value>                 Pool tag to get status for. When provided, instance details are shown by default
      --filter-status=<option>      Filter instances by status (ERROR, ASSIGNED, AVAILABLE, etc.)
                                    <options:
                                    ERROR|ASSIGNED|AVAILABLE|PROVISIONING|ACTIVATING|EXPIRED|DELETING|ORPHANED>
      --loglevel=<option>           [default: info] logging level for this command invocation
                                    <options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
      --sfp-server-url=<value>      URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                    config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Get detailed status and statistics for a sandbox pool. When a specific pool tag is provided, instance details are
  shown by default.

EXAMPLES
  $ sfp server pool status --repository myorg/myrepo --tag dev_pool  # Shows pool summary + instances

  $ sfp server pool status --repository myorg/myrepo  # Shows all pools summary

  $ sfp server pool status --repository myorg/myrepo --tag dev_pool --no-instances  # Pool summary only

  $ sfp server pool status --repository myorg/myrepo --tag dev_pool --filter-status ERROR  # Show only ERROR instances

See code: src/commands/server/pool/status.ts

Org

Previous Page

Project

Next Page

On this page

sfp server pool cleanupsfp server pool config createsfp server pool config deletesfp server pool config getsfp server pool config listsfp server pool config pushsfp server pool config updatesfp server pool drainsfp server pool monitorsfp server pool replenishsfp server pool scratch initsfp server pool status