@salesforce/plugin-evergreen
Salesforce SFDX CLI Evergreen Plugin
Last updated 6 days ago by jgrantham .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @salesforce/plugin-evergreen 
SYNC missed versions from official npm registry.

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:auth:bearer

output 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:eventconnection:create

create a connection from an event source that will invoke a function

USAGE
  $ sfdx evergreen:eventconnection:create

OPTIONS
  -e, --eventsource=eventsource  (required) event source name
  -f, --function=function        (required) function name to which event source is connected
  -n, --namespace=namespace      (required) namespace name to which function belongs
  -p, --project=project          (required) project name to which event source and function belong
  -s, --space=space              (required) space name to which event source and function belong
  -t, --target=target            target name that specifies a combination of project, space or namespace

EXAMPLE
  $ sfdx evergreen:eventconnection:connect --project=my-project --space=my-space --namespace=my-namespace 
  --function=my-function --eventsource=my-eventsource

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

sfdx evergreen:eventconnection:delete

disconnect an event source from a function

USAGE
  $ sfdx evergreen:eventconnection:delete

OPTIONS
  -e, --eventsource=eventsource  (required) event source name
  -f, --function=function        (required) function name to which event source is connected
  -n, --namespace=namespace      (required) namespace name to which function belongs
  -p, --project=project          (required) project name to which event source and function belong
  -s, --space=space              (required) space name to which event source and function belong
  -t, --target=target            target name that specifies a combination of project, space or namespace
  --noprompt                     auto confirms the deletion of the connection if passed in

ALIASES
  $ sfdx evergreen:eventconnection:remove
  $ sfdx evergreen:eventconnection:rm

EXAMPLES
  $ sfdx evergreen:eventconnection:delete --project=my-project --space=my-space --namespace=my-namespace 
  --function=my-function --eventsource=my-eventsource
  $ sfdx evergreen:eventconnection:delete --project=my-project --space=my-space --namespace=my-namespace 
  --function=my-function --eventsource=my-eventsource --noprompt

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

sfdx evergreen:eventconnection:list

list a space's connections between event sources and functions in a table

USAGE
  $ sfdx evergreen:eventconnection:list

OPTIONS
  -e, --eventsource=eventsource  event source name to list connections for
  -f, --function=function        function name to list connections for
  -n, --namespace=namespace      namespace name to show connections for
  -p, --project=project          (required) project name to show connections for
  -s, --space=space              (required) space name to show connections for
  -t, --target=target            target name that specifies a combination of project, space or namespace
  -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:eventconnection:ls

EXAMPLES
  $ sfdx evergreen:eventconnection:list --project=my-project --space=my-space --function=my-function
  $ sfdx evergreen:eventconnection:list --project=my-project --space=my-space --eventsource=my-eventsource

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

sfdx evergreen:eventsource:create EVENTSOURCE

create an event source

USAGE
  $ sfdx evergreen:eventsource:create EVENTSOURCE

ARGUMENTS
  EVENTSOURCE  event source name

OPTIONS
  -c, --config=config                    a pair of config key values
  -p, --project=project                  (required) project name to create an event source for
  -s, --space=space                      (required) space name to create an event source for
  -t, --target=target                    target name that specifies a combination of project, space or namespace
  -w, --wait                             wait until complete to exit
  --type=SFDC_PLATFORM_EVENT|CRON_EVENT  (required) type of the event source

EXAMPLES
  $ sfdx evergreen:eventsource:create my-event-source-for-room-status-update \
    --project=my-project \
    --space=my-space \
    --type SFDC_PLATFORM_EVENT \
    --config "eventName=room-status-update" \
    --config "sfdcOrgToken=8c712f6f-0755-4b26-964b-51bc6b58b8cd" \
    --config "sfdcOrgInstanceUrl=https://instance-id.salesforce.com"
  $ sfdx evergreen:eventsource:create my-nightly-event-source \
    --project=my-project \
    --space=my-space \
    --type CRON_EVENT \
    --config "schedule=0 23 * * *"

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

sfdx evergreen:eventsource:delete EVENTSOURCE

delete an event source

USAGE
  $ sfdx evergreen:eventsource:delete EVENTSOURCE

ARGUMENTS
  EVENTSOURCE  event source name

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

ALIASES
  $ sfdx evergreen:eventsource:remove
  $ sfdx evergreen:eventsource:rm

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

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

sfdx evergreen:eventsource:list

list a space's event sources in a table

USAGE
  $ sfdx evergreen:eventsource:list

OPTIONS
  -p, --project=project  (required) project name to list event sources for
  -s, --space=space      (required) space name to list event sources for
  -t, --target=target    target name that specifies a combination of project, space or namespace
  -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:eventsource:ls

EXAMPLE
  $ sfdx evergreen:eventsource:list --project=my-project --space=my-space

See code: src/commands/evergreen/eventsource/list.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: .] 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
  -m, --metadir=metadir                   the relative path to sfdx project root where the metadata will be created

ALIASES
  $ sfdx evergreen:function:init

EXAMPLES
  $ sfdx evergreen:function:create MyFunction --language=javascript
  $ sfdx evergreen:function:create MyFunction --language=javascript --metadir=force-app/main/default

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
  -c, --confirm=name         confirmation name
  -n, --namespace=namespace  (required) namespace to delete the function from
  -p, --project=project      (required) project to delete the function from
  -s, --space=space          (required) space to delete the function from
  -t, --target=target        target name that specifies a combination of project, space or namespace
  -w, --wait                 wait until complete to exit

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

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

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

sfdx evergreen:function:deploy FUNCTION

deploy function

USAGE
  $ sfdx evergreen:function:deploy FUNCTION

ARGUMENTS
  FUNCTION  function name

OPTIONS
  -f, --functionbundlerootdir=functionbundlerootdir  root of directory containing function bundle to deploy or filepath
                                                     to function bundle to deploy

  -n, --namespace=namespace                          existing namespace containing function; if provided, project and
                                                     space are required

  -p, --project=project                              existing project containing function; if provided, space and
                                                     namespace are required

  -s, --space=space                                  existing space to create a function for; if provided, project and
                                                     namespace are required

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

  -u, --targetusername=targetusername                username or alias for the target org to deploy function bundle;
                                                     overrides default target org

  -v, --verbose                                      verbose output

EXAMPLES
  $ sfdx evergreen:function:deploy MyFunction
  $ sfdx evergreen:function:deploy MyFunction -f ../../force-app
  $ sfdx evergreen:function:deploy MyFunction -f 
  ../../force-app/main/default/functionBundles/MyFunction/MyFunction.code-meta.xml -u myorg
  $ sfdx evergreen:function:deploy MyFunction -f ../../force-app -p myproject -s myspace -n mynamespace

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
  -p, --project=project  (required) project name to list functions for
  -s, --space=space      (required) space name to list functions for
  -t, --target=target    target name that specifies a combination of project, space or namespace
  -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 --project=my-project --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
  -f, --function=function    (required) function name to release
  -i, --image=image          (required) image name to release
  -n, --namespace=namespace  (required) namespace name of function to release
  -p, --project=project      (required) project name of function to release
  -s, --space=space          (required) space name of function to release
  -t, --target=target        target name that specifies a combination of project, space or namespace

EXAMPLE
  $ sfdx evergreen:function:release --image=org/image:v2 --function=my-function --project=my-project --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
  -e, --env=env      set environment variables
  -v, --verbose      output additional logs
  --builder=builder  set custom builder image

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

EXAMPLE

       $ sfdx evergreen:function:start
       $ sfdx evergreen:function:start -e VAR=VALUE
       $ sfdx evergreen:function:start --network host

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
  -n, --namespace=namespace  (required) namespace name of function to update
  -p, --project=project      (required) project 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 project, space or namespace
  --private
  --public

EXAMPLES
  $ sfdx evergreen:function:update my-function --project=my-project --space=my-space --namespace=my-namespace --public
  $ sfdx evergreen:function:update my-function --project=my-project --space=my-space --namespace=my-namespace --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
  -p, --project=project  project name
  -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 --project=project-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
  -f, --function=function    (required) function name of function to retrieve logs
  -n, --namespace=namespace  (required) namespace name of function to retrieve logs
  -p, --project=project      (required) project 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 project, space or namespace

EXAMPLE
  $ evergreen logs --project hotel-sf --space production --namespace examplenamespace --function exampleFunction

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

sfdx evergreen:namespace:create NAMESPACE

create a namespace for a space

USAGE
  $ sfdx evergreen:namespace:create NAMESPACE

ARGUMENTS
  NAMESPACE  namespace name

OPTIONS
  -p, --project=project  (required) project to create a namespace for
  -s, --space=space      (required) space to create a namespace for
  -t, --target=target    target name that specifies a combination of project, space or namespace
  -w, --wait             wait until complete to exit

EXAMPLES
  $ sfdx evergreen:namespace:create my-namespace --project=my-project --space=my-space
  $ sfdx evergreen:namespace:create my-namespace --project=my-project --space=my-space --wait

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

sfdx evergreen:namespace:delete NAMESPACE

delete a namespace

USAGE
  $ sfdx evergreen:namespace:delete NAMESPACE

ARGUMENTS
  NAMESPACE  namespace name

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

ALIASES
  $ sfdx evergreen:namespace:remove
  $ sfdx evergreen:namespace:rm

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

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

sfdx evergreen:namespace:list

list a space's namespaces in a table

USAGE
  $ sfdx evergreen:namespace:list

OPTIONS
  -p, --project=project  (required) project name for functions
  -s, --space=space      (required) space name to list functions for
  -t, --target=target    target name that specifies a combination of project, space or namespace
  -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:namespace:ls

EXAMPLE
  $ sfdx evergreen:namespace:list --project=my-project --space=my-space

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

sfdx evergreen:project:create PROJECT

create a project

USAGE
  $ sfdx evergreen:project:create PROJECT

ARGUMENTS
  PROJECT  project name

EXAMPLE
  $ sfdx evergreen:project:create my-project

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

sfdx evergreen:project:delete PROJECT

delete a project

USAGE
  $ sfdx evergreen:project:delete PROJECT

ARGUMENTS
  PROJECT  project name

OPTIONS
  -c, --confirm=name  confirmation name

ALIASES
  $ sfdx evergreen:project:remove
  $ sfdx evergreen:project:rm

EXAMPLES
  $ sfdx evergreen:project:delete project-name
  $ sfdx evergreen:project:delete project-name --confirm project-name

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

sfdx evergreen:project:list [PROJECT]

list your project(s) in a table

USAGE
  $ sfdx evergreen:project:list [PROJECT]

ARGUMENTS
  PROJECT  project name(s) to 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:project:ls

EXAMPLES
  $ sfdx evergreen:project:list
  $ sfdx evergreen:project:list my-project
  $ sfdx evergreen:project:list my-project my-other-project

See code: src/commands/evergreen/project/list.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
  -p, --project=project  (required) project to list secret bindings for
  -s, --space=space      (required) space to list secret bindings for
  -t, --target=target    target name that specifies a combination of project, space or namespace
  -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 --project=my-project --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
  -p, --project=project  (required) project name to create a secret for
  -s, --space=space      (required) space name to create a secret for
  -t, --target=target    target name that specifies a combination of project, space or namespace
  --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 --project=my-project --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
  -p, --project=project  (required) project name to list secrets for
  -s, --space=space      (required) space name to list secrets for
  -t, --target=target    target name that specifies a combination of project, space or namespace
  -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 \
  --project=my-project \
  --space=my-space

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

sfdx evergreen:secret:delete [SECRET]

remove a secret from a space

USAGE
  $ sfdx evergreen:secret:delete [SECRET]

ARGUMENTS
  SECRET  secret name

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

ALIASES
  $ sfdx evergreen:secret:remove
  $ sfdx evergreen:secret:rm

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

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

sfdx evergreen:secret:delete:key [KEY]

remove 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
  -p, --project=project  (required) project to delete a key from
  -s, --space=space      (required) space to delete a key from
  -t, --target=target    target name that specifies a combination of project, space or namespace
  --secret=secret        (required) secret to delete a key from

ALIASES
  $ sfdx evergreen:secret:remove:key
  $ sfdx evergreen:secret:rm:key

EXAMPLES
  $ sfdx evergreen:secret:delete:key my-key --project=my-project --space=my-space --secret=my-secret
  $ sfdx evergreen:secret:delete:key my-key --project=my-project --space=my-space --secret=my-secret --confirm my-key
  $ sfdx evergreen:secret:delete:key my-key --project=my-project --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
  -f, --function=function    (required) name of the function to bind
  -n, --namespace=namespace  (required) name of the namespace that contains the function
  -p, --project=project      (required) name of the project that contains the space
  -s, --space=space          (required) name of the space that contains the namespace and secret
  -t, --target=target        target name that specifies a combination of project, space or namespace
  --secret=secret            (required) name of the secret to bind

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

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
  -c, --confirm=name         confirmation name
  -f, --function=function    (required) name of the function to unbind
  -n, --namespace=namespace  (required) name of the namespace that contains the function
  -p, --project=project      (required) name of the project that contains the space
  -s, --space=space          (required) name of the space that contains the namespace and secret
  -t, --target=target        target name that specifies a combination of project, space or namespace
  --secret=secret            (required) name of the secret to unbind

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

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

sfdx evergreen:secret:list

list your secret(s) in a table

USAGE
  $ sfdx evergreen:secret:list

OPTIONS
  -p, --project=project  (required) project name to list secrets for
  -s, --space=space      (required) space name to list secrets for
  -t, --target=target    target name that specifies a combination of project, space or namespace
  -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 --project=my-project --space=my-space

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

sfdx evergreen:secret:namespace:bind

bind a secret to a namespace

USAGE
  $ sfdx evergreen:secret:namespace:bind

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

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

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

sfdx evergreen:secret:namespace:unbind

unbind a secret from a namespace

USAGE
  $ sfdx evergreen:secret:namespace:unbind

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

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

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

sfdx evergreen:secret:update SECRET

set one or more key/value pairs in a secret

USAGE
  $ sfdx evergreen:secret:update SECRET

ARGUMENTS
  SECRET  secret name

OPTIONS
  -p, --project=project  (required) project name to list secrets for
  -s, --space=space      (required) space name to list secrets for
  -t, --target=target    target name that specifies a combination of project, space or namespace
  --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 --project=my-project --space=my-space --data=mykey=somevalue

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

sfdx evergreen:space:create SPACE

create a space for a project

USAGE
  $ sfdx evergreen:space:create SPACE

ARGUMENTS
  SPACE  space name

OPTIONS
  -p, --project=project  (required) project name to create a space for
  -t, --target=target    target name that specifies a combination of project, space or namespace
  -w, --wait             wait until complete to exit

EXAMPLES
  $ sfdx evergreen:space:create my-space --project=my-project
  $ sfdx evergreen:space:create my-space --wait --project=my-project

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
  -p, --project=project  (required) project name the space belongs to
  -t, --target=target    target name that specifies a combination of project, space or namespace
  -w, --wait             wait until complete to exit

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

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

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

sfdx evergreen:space:list

list a project's spaces in a table

USAGE
  $ sfdx evergreen:space:list

OPTIONS
  -p, --project=project  (required) project name to list spaces for
  -t, --target=target    target name that specifies a combination of project, space or namespace
  -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 --project=my-project

See code: src/commands/evergreen/space/list.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

Current Tags

  • 0.22.2                                ...           latest (6 days ago)

18 Versions

  • 0.22.2                                ...           6 days ago
  • 0.22.1                                ...           18 days ago
  • 0.21.1                                ...           21 days ago
  • 0.21.0                                ...           a month ago
  • 0.20.0                                ...           2 months ago
  • 0.19.0                                ...           2 months ago
  • 0.18.0                                ...           2 months ago
  • 0.17.0                                ...           2 months ago
  • 0.16.0                                ...           3 months ago
  • 0.15.0                                ...           3 months ago
  • 0.14.0                                ...           3 months ago
  • 0.13.1                                ...           3 months ago
  • 0.13.0                                ...           3 months ago
  • 0.12.0                                ...           3 months ago
  • 0.11.0                                ...           3 months ago
  • 0.10.0                                ...           3 months ago
  • 0.9.1                                ...           4 months ago
  • 0.9.0                                ...           4 months ago
Downloads
Today 0
This Week 0
This Month 41
Last Day 0
Last Week 11
Last Month 18

Copyright 2014 - 2016 © taobao.org |