@salesforce/plugin-evergreen
TypeScript icon, indicating that this package has built-in type declarations

0.34.0 • Public • Published

Salesforce SDFX CLI Evergreen Plugin

Note: This feature is in beta and has been released early so we can collect feedback. It may contain significant problems, undergo major changes, or be discontinued. The use of this feature is governed by the Salesforce.com Program Agreement.

oclif Version CircleCI Appveyor CI Codecov Downloads/week License

Developing

Check out the Evergreen CLI Plugins Development Guide.

Releasing

Check out the Evergreen CLI Plugins Release Guide.

Usage

Install via npm

To install the Evergreen plugin via npm you need to have access to the Heroku npm org. To do so:

  1. Install the SFDX CLI: Install instructions
  2. Then run sfdx plugins:install @salesforce/plugin-evergreen:
$ sfdx plugins:install @salesforce/plugin-evergreen
running command...
$ sfdx evergreen --help [COMMAND]
USAGE
  $ sfdx evergreen:COMMAND
...

Install via Github

Alternatively, you can get the latest version from github and use ./bin/run command to run each command. In order to run evergreen command you can set alias evergreen="$(pwd)/bin/run"

Environment Variables

There are a number of values in Evergreen CLI that can be configured via environment variables. Copy the .env.example to .env in order customize them.

Commands

sfdx evergreen:app:create APP

create an app for a space

USAGE
  $ sfdx evergreen:app:create APP

ARGUMENTS
  APP  app name

OPTIONS
  -s, --space=space    (required) space to create an app for
  -t, --target=target  target name that specifies a combination of space or app
  -w, --wait           wait until complete to exit
  --default            set app as default target

EXAMPLES
  $ sfdx evergreen:app:create my-app --space=my-space
  $ sfdx evergreen:app:create my-app --space=my-space --wait
  $ sfdx evergreen:app:create my-app --space=my-space --default

See code: src/commands/evergreen/app/create.ts

sfdx evergreen:app:delete APP

delete an app

USAGE
  $ sfdx evergreen:app:delete APP

ARGUMENTS
  APP  app name

OPTIONS
  -c, --confirm=name   confirmation name
  -s, --space=space    (required) space name to remove an app from
  -t, --target=target  target name that specifies a combination of space or app
  -w, --wait           wait until complete to exit

ALIASES
  $ sfdx evergreen:app:remove
  $ sfdx evergreen:app:rm

EXAMPLES
  $ sfdx evergreen:app:delete my-app --space=my-space
  $ sfdx evergreen:app:delete my-app --space=my-space --wait
  $ sfdx evergreen:app:delete my-app --space=my-space --confirm my-app

See code: src/commands/evergreen/app/delete.ts

sfdx evergreen:app:describe APP

list all Salesforce org connections bound to a given app

USAGE
  $ sfdx evergreen:app:describe APP

ARGUMENTS
  APP  app name

OPTIONS
  -s, --space=space    (required) space name
  -t, --target=target  target name that specifies a combination of space or app
  -x, --extended       show extra columns
  --columns=columns    only show provided columns (comma-separated)
  --filter=filter      filter property by partial string matching, ex: name=foo
  --no-header          hide table header from output
  --no-truncate        do not truncate output to fit screen
  --output=json|csv    output table in a more machine friendly format
  --sort=sort          property to sort by (prepend '-' for descending)

EXAMPLE
  sfdx evergreen:app:describe staging --space=my-space

See code: src/commands/evergreen/app/describe.ts

sfdx evergreen:app:list

list a space's apps in a table

USAGE
  $ sfdx evergreen:app:list

OPTIONS
  -s, --space=space    (required) space name to list functions for
  -t, --target=target  target name that specifies a combination of space or app
  -x, --extended       show extra columns
  --columns=columns    only show provided columns (comma-separated)
  --filter=filter      filter property by partial string matching, ex: name=foo
  --no-header          hide table header from output
  --no-truncate        do not truncate output to fit screen
  --output=json|csv    output table in a more machine friendly format
  --sort=sort          property to sort by (prepend '-' for descending)

ALIASES
  $ sfdx evergreen:app:ls

EXAMPLE
  $ sfdx evergreen:app:list --space=my-space

See code: src/commands/evergreen/app/list.ts

sfdx evergreen:auth:bearer

display your local bearer token

USAGE
  $ sfdx evergreen:auth:bearer

EXAMPLE
  $ sfdx evergreen:auth:bearer

See code: src/commands/evergreen/auth/bearer.ts

sfdx evergreen:auth:login

log into your account

USAGE
  $ sfdx evergreen:auth:login

ALIASES
  $ sfdx evergreen:login

EXAMPLE
  $ sfdx evergreen:auth:login

See code: src/commands/evergreen/auth/login.ts

sfdx evergreen:auth:logout

log out of your account

USAGE
  $ sfdx evergreen:auth:logout

ALIASES
  $ sfdx evergreen:logout

EXAMPLE
  $ sfdx evergreen:auth:logout

See code: src/commands/evergreen/auth/logout.ts

sfdx evergreen:function:build IMAGE

build function source code into a deployable image

USAGE
  $ sfdx evergreen:function:build IMAGE

ARGUMENTS
  IMAGE  image name, must be in all lowercase

OPTIONS
  -e, --env=env          Build-time environment variable, in the form 'VAR=VALUE'or 'VAR'. When using latter value-less
                         form, value will be taken from current environment at the time this command is executed. This
                         flag may occur multiple times if more than one variable is desired.

  -p, --path=path        [default: /home/circleci/project] path to function dir

  -v, --verbose          output raw build logs

  --buildpack=buildpack  Buildpack ID, path to a Buildpack directory, or path/URL to a Buildpack .tgz file. Repeat for
                         each buildpack in order.

  --clear-cache          Clear image's associated cache before building.

  --env-file=env-file    Build-time environment variables file comprised of one variable per line, of the form
                         'VAR=VALUE' or 'VAR' When using latter value-less form, value will be taken from current
                         environment at the time this command is executed.

  --network=network      Connect and build containers to a network. This can be useful to build containers which require
                         a local resource.

  --no-pull              Skip pulling builder and run images before use.

EXAMPLE

       $ sfdx evergreen:function:build image-repo/myfunction:dev
       $ sfdx evergreen:function:build image-repo/myfunction:dev --path /path/to/function/src
       $ sfdx evergreen:function:build image-repo/myfunction:dev --network host

See code: @salesforce/plugin-evergreen-build

sfdx evergreen:function:create FUNCTION

create a function with basic scaffolding specific to a given language

USAGE
  $ sfdx evergreen:function:create FUNCTION

ARGUMENTS
  FUNCTION  function name

OPTIONS
  -l, --language=(javascript|typescript)  (required) language

ALIASES
  $ sfdx evergreen:function:init

EXAMPLE
  $ sfdx evergreen:function:create MyFunction --language=javascript

See code: src/commands/evergreen/function/create.ts

sfdx evergreen:function:delete FUNCTION

delete a function

USAGE
  $ sfdx evergreen:function:delete FUNCTION

ARGUMENTS
  FUNCTION  function name

OPTIONS
  -a, --app=app        (required) app to delete the function from
  -c, --confirm=name   confirmation name
  -s, --space=space    (required) space to delete the function from
  -t, --target=target  target name that specifies a combination of space or app
  -w, --wait           wait until complete to exit

ALIASES
  $ sfdx evergreen:function:remove
  $ sfdx evergreen:function:rm

EXAMPLES
  $ sfdx evergreen:function:delete my-function --space=my-space --app=my-app
  $ sfdx evergreen:function:delete my-function --space=my-space --app=my-app --wait
  $ sfdx evergreen:function:delete my-function --space=my-space --app=my-app --confirm my-function

See code: src/commands/evergreen/function/delete.ts

sfdx evergreen:function:deploy

deploy function

USAGE
  $ sfdx evergreen:function:deploy

OPTIONS
  -a, --app=app                        existing app containing function; if provided, space is required

  -e, --env=env                        [BUILD OPTION] Build-time environment variable, in the form 'VAR=VALUE'or 'VAR'.
                                       When using latter value-less form, value will be taken from current environment
                                       at the time this command is executed. This flag may occur multiple times if more
                                       than one variable is desired.

  -p, --path=path                      [default: /root/cli] path to function dir

  -s, --space=space                    existing space to create a function for; if provided, app is required

  -t, --target=target                  target name that specifies a combination of space or app

  -u, --targetusername=targetusername  username or alias for the target org; if provided, will deploy function reference
                                       to org

  -v, --verbose                        verbose output

  --buildpack=buildpack                Buildpack ID, path to a Buildpack directory, or path/URL to a Buildpack .tgz
                                       file. Repeat for each buildpack in order.

  --clear-cache                        [BUILD OPTION] Clear image's associated cache before building.

  --network=network                    [BUILD OPTION] Connect and build containers to a network. This can be useful to
                                       build containers which require a local resource.

  --no-pull                            [BUILD OPTION] Skip pulling builder and run images before use.

EXAMPLES
  $ sfdx evergreen:function:deploy
  $ sfdx evergreen:function:deploy -u myorg
  $ sfdx evergreen:function:deploy -u myorg -s myspace -a myapp
  $ sfdx evergreen:function:deploy -p /path/to/function/src

See code: src/commands/evergreen/function/deploy.ts

sfdx evergreen:function:invoke URL

send a cloudevent to a function

USAGE
  $ sfdx evergreen:function:invoke URL

ARGUMENTS
  URL  The target url

OPTIONS
  -H, --headers=headers                set headers
  -p, --payload=payload                set the payload of the cloudevent. also accepts @file.txt format
  -u, --targetusername=targetusername  username or alias for the target org; overrides default target org
  --structured                         set the cloudevent to be emitted as a structured cloudevent (json)

EXAMPLE

       $ sfdx evergreen:function:invoke http://localhost:8080 -p '{"id": 12345}'
       $ sfdx evergreen:function:invoke http://localhost:8080 -p '@file.json'
       $ echo '{"id": 12345}' | sfdx evergreen:function:invoke http://localhost:8080
       $ sfdx evergreen:function:invoke http://localhost:8080 -p '{"id": 12345}' --structured

See code: @salesforce/plugin-evergreen-build

sfdx evergreen:function:list

list a space's functions in a table

USAGE
  $ sfdx evergreen:function:list

OPTIONS
  -s, --space=space    (required) space name to list functions for
  -t, --target=target  target name that specifies a combination of space or app
  -x, --extended       show extra columns
  --columns=columns    only show provided columns (comma-separated)
  --filter=filter      filter property by partial string matching, ex: name=foo
  --no-header          hide table header from output
  --no-truncate        do not truncate output to fit screen
  --output=json|csv    output table in a more machine friendly format
  --sort=sort          property to sort by (prepend '-' for descending)

ALIASES
  $ sfdx evergreen:function:ls

EXAMPLE
  $ sfdx evergreen:function:list --space=my-space

See code: src/commands/evergreen/function/list.ts

sfdx evergreen:function:release

create a release for a function

USAGE
  $ sfdx evergreen:function:release

OPTIONS
  -a, --app=app            (required) app name of function to release
  -f, --function=function  (required) function name to release
  -i, --image=image        (required) image name to release
  -s, --space=space        (required) space name of function to release
  -t, --target=target      target name that specifies a combination of space or app

EXAMPLE
  $ sfdx evergreen:function:release --image=org/image:v2 --function=my-function --space=my-space

See code: src/commands/evergreen/function/release.ts

sfdx evergreen:function:start

build and run function image locally

USAGE
  $ sfdx evergreen:function:start

OPTIONS
  -d, --debug-port=debug-port  port for remote debugging
  -e, --env=env                set environment variables (provided during build and run)
  -p, --port=port              port for running the function
  -v, --verbose                output additional logs
  --builder=builder            set custom builder image
  --clear-cache                clear associated cache before executing.

  --network=network            Connect and build containers to a network. This can be useful to build containers which
                               require a local resource.

  --no-pull                    skip pulling builder image before use

EXAMPLE

       $ sfdx evergreen:function:start
       $ sfdx evergreen:function:start -e VAR=VALUE
       $ sfdx evergreen:function:start --network host --no-pull --clear-cache --debug-port 9000 --port 5000

See code: @salesforce/plugin-evergreen-build

sfdx evergreen:function:update FUNCTION

update an existing function

USAGE
  $ sfdx evergreen:function:update FUNCTION

ARGUMENTS
  FUNCTION  function name

OPTIONS
  -a, --app=app        (required) app name of function to update
  -s, --space=space    (required) space name of function to update
  -t, --target=target  target name that specifies a combination of space or app
  --private
  --public

EXAMPLES
  $ sfdx evergreen:function:update my-function --space=my-space --app=my-app --public
  $ sfdx evergreen:function:update my-function --space=my-space --app=my-app --private

See code: src/commands/evergreen/function/update.ts

sfdx evergreen:image:push IMAGE

push an image to the registry

USAGE
  $ sfdx evergreen:image:push IMAGE

ARGUMENTS
  IMAGE  image name

OPTIONS
  -s, --space=space  (required) space name or space uuid

ALIASES
  $ sfdx evergreen:function:push

EXAMPLE

       $ sfdx evergreen:image:push image-repo/myfunction:dev --space=space-name
       $ sfdx evergreen:image:push image-repo/myfunction:dev --space=space-uuid

See code: @salesforce/plugin-evergreen-build

sfdx evergreen:logs

stream log output for a function

USAGE
  $ sfdx evergreen:logs

OPTIONS
  -a, --app=app            (required) app name of function to retrieve logs
  -f, --function=function  (required) function name of function to retrieve logs
  -s, --space=space        (required) space name of function to retrieve logs
  -t, --target=target      target name that specifies a combination of space or app

EXAMPLE
  $ evergreen logs hotel-sf --space production --app exampleApp --function exampleFunction

See code: src/commands/evergreen/logs.ts

sfdx evergreen:org:bind [ORGCONNECTION]

bind a Salesforce org connection to an app. you may provide either an org connection as an argument, or the -u flag. If neither are provided, will fallback to default target org.

USAGE
  $ sfdx evergreen:org:bind [ORGCONNECTION]

ARGUMENTS
  ORGCONNECTION  name of the Salesforce org connection to bind. may not be used in conjunction with the -u flag

OPTIONS
  -a, --app=app                        (required) name of the app to bind
  -s, --space=space                    (required) name of the target space
  -t, --target=target                  target name that specifies a combination of space or app

  -u, --targetusername=targetusername  username or alias for the target org; overrides default target org. may not be
                                       used in conjunction with the ORGCONNECTION argument

  --name=name                          name for the Salesforce org connection binding

EXAMPLES
  usage option 1: target username flag (fallback to default if none provided)
     $ sfdx evergreen:org:bind \
        --app=my-app \
        --space=my-space \
        --name=my-binding \
        -u=my-username
     $ sfdx evergreen:org:bind \
        --app=my-app \
        --space=my-space \
        --name=my-binding
  usage option 2: supply org connection as argument
     $ sfdx evergreen:org:bind my-org-connection \
        --app=my-app \
        --space=my-space \
        --name=my-binding

See code: src/commands/evergreen/org/bind.ts

sfdx evergreen:org:list

list your Salesforce org connections in a table

USAGE
  $ sfdx evergreen:org:list

OPTIONS
  -t, --target=target  target name that specifies a combination of space or app
  -x, --extended       show extra columns
  --columns=columns    only show provided columns (comma-separated)
  --filter=filter      filter property by partial string matching, ex: name=foo
  --no-header          hide table header from output
  --no-truncate        do not truncate output to fit screen
  --output=json|csv    output table in a more machine friendly format
  --sort=sort          property to sort by (prepend '-' for descending)

ALIASES
  $ sfdx evergreen:org:ls

EXAMPLE
  $ sfdx evergreen:org:list

See code: src/commands/evergreen/org/list.ts

sfdx evergreen:org:unbind [BINDING]

unbind a Salesforce org connection from an app

USAGE
  $ sfdx evergreen:org:unbind [BINDING]

ARGUMENTS
  BINDING  name of the Salesforce org connection binding to unbind

OPTIONS
  -a, --app=app                        (required) name of the app to unbind
  -c, --confirm=name                   confirmation name
  -s, --space=space                    (required) name of the space that contains the app
  -t, --target=target                  target name that specifies a combination of space or app

  -u, --targetusername=targetusername  username or alias for the target org; overrides default target org. may not be
                                       used in conjunction with the ORGCONNECTION argument

EXAMPLES
  usage option 1: target username flag (fallback to default if none provided)
     $ sfdx evergreen:org:unbind \
        --app=my-app \
        --space=my-space \
        -u=my-username
     $ sfdx evergreen:org:unbind \
        --app=my-app \
        --space=my-space
  usage option 2: supply org binding as argument
     $ sfdx evergreen:org:unbind my-binding \
        --app=my-app \
        --space=my-space
     $ sfdx evergreen:org:unbind my-binding \
        --app=my-app \
        --space=my-space \
        --confirm=my-binding

See code: src/commands/evergreen/org/unbind.ts

sfdx evergreen:secret:app:bind

bind a secret to an app

USAGE
  $ sfdx evergreen:secret:app:bind

OPTIONS
  -a, --app=app        (required) name of the app to bind
  -s, --space=space    (required) name of the space that contains the app and secret
  -t, --target=target  target name that specifies a combination of space or app
  --secret=secret      (required) name of the secret to bind

EXAMPLE
  $ sfdx evergreen:secret:app:bind \
      --secret=my-secret \
      --app=my-app \
      --space=my-space

See code: src/commands/evergreen/secret/app/bind.ts

sfdx evergreen:secret:app:unbind

unbind a secret from an app

USAGE
  $ sfdx evergreen:secret:app:unbind

OPTIONS
  -a, --app=app        (required) name of the app to unbind
  -c, --confirm=name   confirmation name
  -s, --space=space    (required) name of the space that contains the app and secret
  -t, --target=target  target name that specifies a combination of space or app
  --secret=secret      (required) name of the secret to unbind

EXAMPLES
  $ sfdx evergreen:secret:app:unbind \
      --secret=my-secret \
      --app=my-app \
      --space=my-space
  $ sfdx evergreen:secret:app:unbind \
      --secret=my-secret \
      --app=my-app \
      --space=my-space \
      --confirm=my-app

See code: src/commands/evergreen/secret/app/unbind.ts

sfdx evergreen:secret:binding:list SECRET

list a secret's bindings in a table

USAGE
  $ sfdx evergreen:secret:binding:list SECRET

ARGUMENTS
  SECRET  secret name to list bindings for

OPTIONS
  -s, --space=space    (required) space to list secret bindings for
  -t, --target=target  target name that specifies a combination of space or app
  -x, --extended       show extra columns
  --columns=columns    only show provided columns (comma-separated)
  --filter=filter      filter property by partial string matching, ex: name=foo
  --no-header          hide table header from output
  --no-truncate        do not truncate output to fit screen
  --output=json|csv    output table in a more machine friendly format
  --sort=sort          property to sort by (prepend '-' for descending)

ALIASES
  $ sfdx evergreen:secret:binding:ls

EXAMPLE
  $ sfdx evergreen:secret:binding:list my-secret --space=my-space

See code: src/commands/evergreen/secret/binding/list.ts

sfdx evergreen:secret:create [NAME]

create a secret in a space based on a file or specified literal value

USAGE
  $ sfdx evergreen:secret:create [NAME]

ARGUMENTS
  NAME  secret name

OPTIONS
  -s, --space=space      (required) space name to create a secret for
  -t, --target=target    target name that specifies a combination of space or app
  --data=data            a key and literal value to insert into the secret (i.e. mykey=somevalue)
  --from-file=from-file  path to a YAML file specifying the secret’s name and data

EXAMPLE
  $ sfdx evergreen:secret:create my-secret --space=my-space --data=mykey=somevalue

See code: src/commands/evergreen/secret/create.ts

sfdx evergreen:secret:data:list SECRET

list the data within a secret in a table

USAGE
  $ sfdx evergreen:secret:data:list SECRET

OPTIONS
  -s, --space=space    (required) space name to list secrets for
  -t, --target=target  target name that specifies a combination of space or app
  -x, --extended       show extra columns
  --columns=columns    only show provided columns (comma-separated)
  --filter=filter      filter property by partial string matching, ex: name=foo
  --no-header          hide table header from output
  --no-truncate        do not truncate output to fit screen
  --output=json|csv    output table in a more machine friendly format
  --sort=sort          property to sort by (prepend '-' for descending)

ALIASES
  $ sfdx evergreen:secret:data:ls

EXAMPLE
  $ sfdx evergreen:secret:data:list \
  my-secret \
  --space=my-space

See code: src/commands/evergreen/secret/data/list.ts

sfdx evergreen:secret:delete [SECRET]

delete a secret from a space

USAGE
  $ sfdx evergreen:secret:delete [SECRET]

ARGUMENTS
  SECRET  secret name

OPTIONS
  -c, --confirm=name   confirmation name
  -s, --space=space    (required) space to delete a secret from
  -t, --target=target  target name that specifies a combination of space or app

ALIASES
  $ sfdx evergreen:secret:rm

EXAMPLES
  $ sfdx evergreen:secret:delete my-secret --space=my-space
  $ sfdx evergreen:secret:delete my-secret --space=my-space --confirm my-secret

See code: src/commands/evergreen/secret/delete.ts

sfdx evergreen:secret:delete:key [KEY]

delete a key from a secret in a space

USAGE
  $ sfdx evergreen:secret:delete:key [KEY]

ARGUMENTS
  KEY  secret key

OPTIONS
  -c, --confirm=name   confirmation name
  -s, --space=space    (required) space to delete a key from
  -t, --target=target  target name that specifies a combination of space or app
  --secret=secret      (required) secret to delete a key from

ALIASES
  $ sfdx evergreen:secret:rm:key

EXAMPLES
  $ sfdx evergreen:secret:delete:key my-key --space=my-space --secret=my-secret
  $ sfdx evergreen:secret:delete:key my-key --space=my-space --secret=my-secret --confirm my-key
  $ sfdx evergreen:secret:delete:key my-key --space=my-space --secret=my-secret --confirm my-key --confirm my-secret

See code: src/commands/evergreen/secret/delete/key.ts

sfdx evergreen:secret:function:bind

bind a secret to a function

USAGE
  $ sfdx evergreen:secret:function:bind

OPTIONS
  -a, --app=app            (required) name of the app that contains the function
  -f, --function=function  (required) name of the function to bind
  -s, --space=space        (required) name of the space that contains the app and secret
  -t, --target=target      target name that specifies a combination of space or app
  --secret=secret          (required) name of the secret to bind

EXAMPLE
  $ sfdx evergreen:secret:function:bind \
      --secret=my-secret \
      --function=my-function \
      --space=my-space \
      --app=my-app

See code: src/commands/evergreen/secret/function/bind.ts

sfdx evergreen:secret:function:unbind

unbind a secret from a function

USAGE
  $ sfdx evergreen:secret:function:unbind

OPTIONS
  -a, --app=app            (required) name of the app that contains the function
  -c, --confirm=name       confirmation name
  -f, --function=function  (required) name of the function to unbind
  -s, --space=space        (required) name of the space that contains the app and secret
  -t, --target=target      target name that specifies a combination of space or app
  --secret=secret          (required) name of the secret to unbind

EXAMPLES
  $ sfdx evergreen:secret:function:unbind \
      --secret=my-secret \
      --function=my-function \
      --space=my-space \
      --app=my-app
  $ sfdx evergreen:secret:function:unbind \
      --secret=my-secret \
      --function=my-function \
      --space=my-space \
      --app=my-app \
      --confirm=my-function

See code: src/commands/evergreen/secret/function/unbind.ts

sfdx evergreen:secret:list

list your secrets in a table

USAGE
  $ sfdx evergreen:secret:list

OPTIONS
  -s, --space=space    (required) space name to list secrets for
  -t, --target=target  target name that specifies a combination of space or app
  -x, --extended       show extra columns
  --columns=columns    only show provided columns (comma-separated)
  --filter=filter      filter property by partial string matching, ex: name=foo
  --no-header          hide table header from output
  --no-truncate        do not truncate output to fit screen
  --output=json|csv    output table in a more machine friendly format
  --sort=sort          property to sort by (prepend '-' for descending)

ALIASES
  $ sfdx evergreen:secret:ls

EXAMPLE
  $ sfdx evergreen:secret:list --space=my-space

See code: src/commands/evergreen/secret/list.ts

sfdx evergreen:secret:update SECRET

update one or more key/value pairs in a secret

USAGE
  $ sfdx evergreen:secret:update SECRET

ARGUMENTS
  SECRET  secret name

OPTIONS
  -s, --space=space      (required) space name to list secrets for
  -t, --target=target    target name that specifies a combination of space or app
  --data=data            a key and literal value to insert or update in the secret (i.e. mykey=somevalue)
  --force                skip confirmation prompt
  --from-file=from-file  path to a YAML file specifying the secret’s name and data

EXAMPLE
  $ sfdx evergreen:secret:update my-secret --space=my-space --data=mykey=somevalue

See code: src/commands/evergreen/secret/update.ts

sfdx evergreen:space:create SPACE

create a space

USAGE
  $ sfdx evergreen:space:create SPACE

ARGUMENTS
  SPACE  space name

OPTIONS
  -t, --target=target  target name that specifies a combination of space or app
  -w, --wait           wait until complete to exit
  --default            set space as default target

EXAMPLES
  $ sfdx evergreen:space:create my-space
  $ sfdx evergreen:space:create my-space --wait
  $ sfdx evergreen:space:create my-space --default

See code: src/commands/evergreen/space/create.ts

sfdx evergreen:space:delete SPACE

delete a space

USAGE
  $ sfdx evergreen:space:delete SPACE

ARGUMENTS
  SPACE  space name

OPTIONS
  -c, --confirm=name   confirmation name
  -t, --target=target  target name that specifies a combination of space or app
  -w, --wait           wait until complete to exit

ALIASES
  $ sfdx evergreen:space:remove
  $ sfdx evergreen:space:rm

EXAMPLES
  $ sfdx evergreen:space:delete my-space
  $ sfdx evergreen:space:delete my-space --wait
  $ sfdx evergreen:space:delete my-space --confirm my-space

See code: src/commands/evergreen/space/delete.ts

sfdx evergreen:space:list

list spaces in a table

USAGE
  $ sfdx evergreen:space:list

OPTIONS
  -x, --extended     show extra columns
  --columns=columns  only show provided columns (comma-separated)
  --filter=filter    filter property by partial string matching, ex: name=foo
  --no-header        hide table header from output
  --no-truncate      do not truncate output to fit screen
  --output=json|csv  output table in a more machine friendly format
  --sort=sort        property to sort by (prepend '-' for descending)

ALIASES
  $ sfdx evergreen:space:ls

EXAMPLE
  $ sfdx evergreen:space:list

See code: src/commands/evergreen/space/list.ts

sfdx evergreen:target:list

list targets set for Salesforce Functions

USAGE
  $ sfdx evergreen:target:list

OPTIONS
  -x, --extended     show extra columns
  --columns=columns  only show provided columns (comma-separated)
  --filter=filter    filter property by partial string matching, ex: name=foo
  --no-header        hide table header from output
  --no-truncate      do not truncate output to fit screen
  --output=json|csv  output table in a more machine friendly format
  --sort=sort        property to sort by (prepend '-' for descending)

ALIASES
  $ sfdx evergreen:target:ls

EXAMPLE
  $ sfdx evergreen:target:list

See code: src/commands/evergreen/target/list.ts

sfdx evergreen:target:remove TARGET

remove a target currently operating with Salesforce Functions

USAGE
  $ sfdx evergreen:target:remove TARGET

ARGUMENTS
  TARGET  target name

EXAMPLE
  $ sfdx evergreen:target:remove my-target

See code: src/commands/evergreen/target/remove.ts

sfdx evergreen:target:set TARGET

set a target to operate with Salesforce Functions

USAGE
  $ sfdx evergreen:target:set TARGET

ARGUMENTS
  TARGET  target name

OPTIONS
  -a, --app=app      app name
  -s, --space=space  space name
  -x, --extended     show extra columns
  --columns=columns  only show provided columns (comma-separated)
  --filter=filter    filter property by partial string matching, ex: name=foo
  --no-header        hide table header from output
  --no-truncate      do not truncate output to fit screen
  --output=json|csv  output table in a more machine friendly format
  --sort=sort        property to sort by (prepend '-' for descending)

EXAMPLES
  $ sfdx evergreen:target:set my-target --space=my-space
  $ sfdx evergreen:target:set my-other-target --space=my-space --app=my-app

See code: src/commands/evergreen/target/set.ts

sfdx evergreen:whoami

display details of the current logged-in account and user

USAGE
  $ sfdx evergreen:whoami

OPTIONS
  --json  output result in json

EXAMPLE
  $ sfdx evergreen:whoami

See code: src/commands/evergreen/whoami.ts

Readme

Keywords

Package Sidebar

Install

npm i @salesforce/plugin-evergreen

Weekly Downloads

0

Version

0.34.0

License

MIT

Unpacked Size

344 kB

Total Files

141

Last publish

Collaborators

  • dme722
  • nolanlawson
  • ire-npm-team-user
  • jburnie
  • abirchfieldsfdc
  • dlouvton
  • mobify
  • jmsjtu
  • jasonschroeder-sfdc
  • packagellama
  • maward
  • danielshox
  • duane.chew
  • dferro
  • jcourtner
  • jye-sf
  • adirasanam
  • hkii
  • iamaziz
  • dbreese-salesforce
  • ashokrudraraju
  • dhersam
  • demianbrecht
  • mbettio
  • damilareolowoniyi
  • mmadialagan
  • mjrust
  • salesforce-releases
  • mpsenn
  • kevinv11n
  • byao
  • pmdartus
  • ekashida
  • gr8gatsby
  • ravi.jayaramappa
  • apapko
  • jleen-sfdc
  • jqian
  • cwallsf
  • dhagberg-sf
  • khawkins
  • amphro
  • jodarove
  • sfdctaka
  • fernomac
  • jimjag
  • ivarley
  • jbartolotta-sfdc