Install

Installs artifact(s) from a given directory to a target org

sfp install

Installs artifact(s) from a given directory to a target org

USAGE
  $ sfp install -o <value> [--json] [--repository <value>] [-e <value>] [-t <value>] [--sfp-server-url
    <value>] [--artifactdir <value>] [--waittime <value>] [-t <value>] [-b <value> --skipifalreadyinstalled] [-p
    <value>...] [--releaseconfig <value>] [--enablesourcetracking] [--runtests] [--replacementsoverride <value>] [-g
    <value>...] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -b, --baselineorg=<value>           The org against which the package skip should be baselined
  -e, --email=<value>                 [env: SFP_SERVER_USER] Email address for authenticated user. Ignored if
                                      --application-token is provided.
  -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.
  -o, --targetorg=<value>             (required) Username or alias of the target org.
  -p, --artifacts=<value>...          Only install artifacts for the provided packages, use comma separated list of
                                      package names if there are multiple packages
  -t, --application-token=<value>     [env: SFP_SERVER_TOKEN] Application token for CI/CD authentication. Takes
                                      precedence over --email.
  -t, --tag=<value>                   Tag the deploy with a label, useful for identification in metrics
      --artifactdir=<value>           [default: artifacts] The directory containing artifacts to be deployed
      --enablesourcetracking          Enable source tracking on the packages being deployed to an org
      --loglevel=<option>             [default: info] logging level for this command invocation
                                      <options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
      --releaseconfig=<value>         Path to the config file which determines how the packages are deployed based on
                                      the filters in release config
      --replacementsoverride=<value>  Path to a YAML file containing replacement overrides to apply during deployment
      --repository=<value>            The repository identifier. E.g `owner/repo`
      --runtests                      This option forces execution of tests during installation (tests are skipped by
                                      default)
      --sfp-server-url=<value>        [env: SFP_SERVER_URL] URL of the SFP server. Can be set via environment variable
                                      `SFP_SERVER_URL` or config: sfp config:set server-url
      --skipifalreadyinstalled        Skip the package installation if the package is already installed in the org
      --waittime=<value>              [default: 120] Wait time for command to finish in minutes

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs artifact(s) from a given directory to a target org

EXAMPLES
  $ sfp install -o <username>

  $ sfp install -o <username> --runtests

See code: src/commands/install.ts

Last updated

Was this helpful?