1.0.0 • Published 1 year ago

bf-sfdx-plugin v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

bfPackageManagement

Version CircleCI Appveyor CI Greenkeeper Known Vulnerabilities Downloads/week License

$ npm install -g bf-sfdx-plugin
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
bf-sfdx-plugin/1.0.0 darwin-arm64 node-v19.7.0
$ sfdx --help [COMMAND]
USAGE
  $ sfdx COMMAND
...

sfdx bf:openapi:client:generate -s <string> [-p <string>] [-o <string>] [--sfapiversion <string>] [--options <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Generate apex class base on openapi yaml.

USAGE
  $ sfdx bf:openapi:client:generate -s <string> [-p <string>] [-o <string>] [--sfapiversion <string>] [--options 
  <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -o, --outputdir=outputdir
      [default: .] location for the generated classes.

  -p, --classprefix=classprefix
      class prefix for the generated classes.

  -s, --sourcefile=sourcefile
      (required) location for the source file.

  --json
      format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)
      [default: warn] logging level for this command invocation

  --options=options
      [default: namedCredential,models,clients,apis,requests,responses,parameters] comma separated list of options to
      indicate what is generated: namedCredential,model,api,client

  --sfapiversion=sfapiversion
      [default: 55.0] location for the generated classes.

See code: src/commands/bf/openapi/client/generate.ts

sfdx bf:openapi:server:generate -s <string> [-p <string>] [-o <string>] [--sfapiversion <string>] [--options <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Generate apex class base on openapi yaml.

USAGE
  $ sfdx bf:openapi:server:generate -s <string> [-p <string>] [-o <string>] [--sfapiversion <string>] [--options 
  <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -o, --outputdir=outputdir                                                         [default: .] location for the
                                                                                    generated classes.

  -p, --classprefix=classprefix                                                     class prefix for the generated
                                                                                    classes.

  -s, --sourcefile=sourcefile                                                       (required) location for the source
                                                                                    file.

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

  --options=options                                                                 [default: models,requests,responses,
                                                                                    parameters,services,rest] comma
                                                                                    separated list of options to
                                                                                    indicate what is generated:
                                                                                    namedCredential,model,api,client

  --sfapiversion=sfapiversion                                                       [default: 55.0] location for the
                                                                                    generated classes.

See code: src/commands/bf/openapi/server/generate.ts

sfdx bf:org:setup [-s <string>] [-e <string>] [-d <integer>] [-f <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

creates a new scratch org

USAGE
  $ sfdx bf:org:setup [-s <string>] [-e <string>] [-d <integer>] [-f <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -d, --duration=duration                                                           [default: 28] Duration in days
  -e, --email=email                                                                 Email

  -f, --definitionfile=definitionfile                                               [default:
                                                                                    ./config/project-scratch-def.json]
                                                                                    Project Scratch Org Definition file

  -s, --suffix=suffix                                                               name suffix

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLES
  sfdx bf:package:register --packagename "<packagename>" --targetusername "<username>"
          Registers a new package with the given name in the Brightfox package repository in the specified 
  targetusername org.
        
  sfdx bf:package:register -p "<packagename>" -u "<username>"
          Registers a new package with the given name in the Brightfox package repository in the specified 
  targetusername org.

See code: src/commands/bf/org/setup.ts

sfdx bf:package:detail -p <string> -r <string> [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

gets the details of the latest version of a package

USAGE
  $ sfdx bf:package:detail -p <string> -r <string> [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -p, --packagename=packagename                                                     (required) name of the package to
                                                                                    register.

  -r, --repoalias=repoalias                                                         (required) [default: bf-pkg-repo]
                                                                                    Brightfox package repository alias.

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLES
  sfdx bf:package:detail --packagename "<packagename>" -r "<repoalias>"
          Gets the details of the latest version of a package.
        
  sfdx bf:package:detail -p "<packagename>" -r "<repoalias>"
          Gets the details of the latest version of a package.

See code: src/commands/bf/package/detail.ts

sfdx bf:package:install -r <string> [-p <array>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Installs the latest version of a package

USAGE
  $ sfdx bf:package:install -r <string> [-p <array>] [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -p, --packagenames=packagenames                                                   list of package names (comma
                                                                                    separator).

  -r, --repoalias=repoalias                                                         (required) [default: bf-pkg-repo]
                                                                                    Brightfox package repository alias.

  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLES
  sfdx bf:project:package:install -p <comma separated package names> --targetusername "<username>"
          Installs the latest version of specified packages into a target org.
    
  sfdx bf:project:package:install -p <comma separated package names> -u "<username>"
          Installs the latest version of specified packages into a target org.

See code: src/commands/bf/package/install.ts

sfdx bf:package:list -r <string> [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

USAGE
  $ sfdx bf:package:list -r <string> [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -r, --repoalias=repoalias                                                         (required) [default: bf-pkg-repo]
                                                                                    Brightfox package repository alias.

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

See code: src/commands/bf/package/list.ts

sfdx bf:package:register -r <string> [-p <string>] [-d <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

registers a new package into the Brightfox package repository

USAGE
  $ sfdx bf:package:register -r <string> [-p <string>] [-d <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -d, --description=description                                                     short description for the package.
  -p, --packagename=packagename                                                     name of the package to register.

  -r, --repoalias=repoalias                                                         (required) [default: bf-pkg-repo]
                                                                                    Brightfox package repository alias.

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLES
  sfdx bf:package:register --packagename "<packagename>" --targetusername "<username>"
          Registers a new package with the given name in the Brightfox package repository in the specified 
  targetusername org.
        
  sfdx bf:package:register -p "<packagename>" -u "<username>"
          Registers a new package with the given name in the Brightfox package repository in the specified 
  targetusername org.

See code: src/commands/bf/package/register.ts

sfdx bf:package:version:list -r <string> [-p <string>] [--onlypromoted] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

USAGE
  $ sfdx bf:package:version:list -r <string> [-p <string>] [--onlypromoted] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -p, --packagename=packagename                                                     name of the package to register.

  -r, --repoalias=repoalias                                                         (required) [default: bf-pkg-repo]
                                                                                    Brightfox package repository alias.

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

  --onlypromoted                                                                    to show only promoted package
                                                                                    versions.

See code: src/commands/bf/package/version/list.ts

sfdx bf:package:version:register -r <string> [-p <string>] [-v <string>] [-i <string>] [--promote] [--latest] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

registers a new package version into the Brightfox package repository

USAGE
  $ sfdx bf:package:version:register -r <string> [-p <string>] [-v <string>] [-i <string>] [--promote] [--latest] 
  [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -i, --versionid=versionid                                                         id of the package version to
                                                                                    register.

  -p, --packagename=packagename                                                     name of the package to register.

  -r, --repoalias=repoalias                                                         (required) [default: bf-pkg-repo]
                                                                                    Brightfox package repository alias.

  -v, --versionname=versionname                                                     name of the package version to
                                                                                    register.

  --json                                                                            format output as json

  --latest                                                                          register latest package version

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

  --promote                                                                         indicates if the version is promoted
                                                                                    yes or no.

EXAMPLES
  sfdx bf:package:register --packagename "<packagename>" --versionname "<versionname>" --versionid "<versionid>" 
  --targetusername "<username>"
          Registers a new package version with the given name in the Brightfox package repository in the specified 
  targetusername org.
        
  sfdx bf:package:register -p "<packagename>" -v "<versionname>" -i "<versionid>" -u "<username> --promote"
          Registers a new promoted package version with the given name in the Brightfox package repository in the 
  specified targetusername org.

See code: src/commands/bf/package/version/register.ts

sfdx bf:project:create -n <string> -v <string> [-d <string>] [-a <string>] [-g <string>] [-i] [--sfapiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Creates a new DX project.

USAGE
  $ sfdx bf:project:create -n <string> -v <string> [-d <string>] [-a <string>] [-g <string>] [-i] [--sfapiversion 
  <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -a, --author=author                                                               author
  -d, --description=description                                                     project description
  -g, --gitrepourl=gitrepourl                                                       url git repository
  -i, --npminstall                                                                  install node modules
  -n, --projectname=projectname                                                     (required) project name
  -v, --devhubname=devhubname                                                       (required) devhub name
  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

  --sfapiversion=sfapiversion                                                       [default: 55.0] install node modules

EXAMPLES
  sfdx bf:project:create -n "projectname" -v "devhubname"
          Sets up a new dx project
        
  sfdx bf:project:create:add --projectname "projectname" -devhubname "devhubname"
          Sets up a new dx project

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

sfdx bf:project:package:add -p <array> -r <string> [-d] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Adds a new package alias(es) to the project json file.

USAGE
  $ sfdx bf:project:package:add -p <array> -r <string> [-d] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -d, --createdependency                                                            create a dependency entry for the
                                                                                    specified packages.

  -p, --packagenames=packagenames                                                   (required) list of package names
                                                                                    (comma separator).

  -r, --repoalias=repoalias                                                         (required) [default: bf-pkg-repo]
                                                                                    Brightfox package repository alias.

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLES
  sfdx bf:project:package:add --packagenames "<packagenames>" --targetusername "<username>"
          Adds a new packages with the given names to the project json file.
        
  sfdx bf:project:package:add -p "<packagenames>" -u "<username>"
          Adds a new packages with the given names to the project json file.

See code: src/commands/bf/project/package/add.ts

sfdx bf:project:package:check -r <string> [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Checks if package aliases are the latest version.

USAGE
  $ sfdx bf:project:package:check -r <string> [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -r, --repoalias=repoalias                                                         (required) [default: bf-pkg-repo]
                                                                                    Brightfox package repository alias.

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLES
  sfdx bf:project:package:check --targetusername "<username>"
          Checks all package aliases in the project json file.
  sfdx bf:project:package:check -u "<username>"
          Checks all package aliases in the project json file.

See code: src/commands/bf/project/package/check.ts

sfdx bf:project:package:install [-p <array>] [-s <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Installs packages defined in the packageAliases section of the project json file.

USAGE
  $ sfdx bf:project:package:install [-p <array>] [-s <string>] [-u <string>] [--apiversion <string>] [--json] 
  [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -p, --packagenames=packagenames                                                   list of package names (comma
                                                                                    separator).

  -s, --startfrompackage=startfrompackage                                           start installing from package name.

  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLES
  sfdx bf:project:package:install --targetusername "<username>"
          Installs packages defined in the packageAliases section of the project json file.
    
  sfdx bf:project:package:install -u "<username>"
          Installs packages defined in the packageAliases section of the project json file.

See code: src/commands/bf/project/package/install.ts

sfdx bf:project:package:remove -p <array> [-d] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Removes package alias(es) from the project json file.

USAGE
  $ sfdx bf:project:package:remove -p <array> [-d] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -d, --createdependency                                                            name of the package to register.

  -p, --packagenames=packagenames                                                   (required) name of the package to
                                                                                    register.

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLES
  sfdx bf:project:package:remove --packagenames "<packagenames>" --targetusername "<username>"
          Removes packages with the given names from the project json file.
        
  sfdx bf:project:package:add -p "<packagenames>" -u "<username>"
          Removes packages with the given names from the project json file.

See code: src/commands/bf/project/package/remove.ts

sfdx bf:project:package:retrieve [-d] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Retrieves packages installed in the specified targetusername org.

USAGE
  $ sfdx bf:project:package:retrieve [-d] [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -d, --createdependency                                                            Creates a package depencency

  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLES
  sfdx bf:project:package:retrieve --packagename "<packagename>" --createdependency --targetusername "<username>"
          Retrieves packages installed in the specified targetusername org.
    
  sfdx bf:project:package:retrieve -p "<packagename>" -d -u "<username>"
          Retrieves packages installed in the specified targetusername org.

See code: src/commands/bf/project/package/retrieve.ts

sfdx bf:project:package:upgrade -r <string> [-i] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Upgrades all package aliases to the latest versions.

USAGE
  $ sfdx bf:project:package:upgrade -r <string> [-i] [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -i, --install                                                                     install packages

  -r, --repoalias=repoalias                                                         (required) [default: bf-pkg-repo]
                                                                                    Brightfox package repository alias.

  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLES
  sfdx bf:project:package:upgrade --targetusername "<username>"
          Upgrades all package aliases to the latest versions.
        
  sfdx bf:project:package:upgrade -u "<username>"
          Upgrades all package aliases to the latest versions.

See code: src/commands/bf/project/package/upgrade.ts

Debugging your plugin

We recommend using the Visual Studio Code (VS Code) IDE for your plugin development. Included in the .vscode directory of this plugin is a launch.json config file, which allows you to attach a debugger to the node process when running your commands.

To debug the hello:org command: 1. Start the inspector

If you linked your plugin to the sfdx cli, call your command with the dev-suspend switch: 

$ sfdx hello:org -u myOrg@example.com --dev-suspend

Alternatively, to call your command using the bin/run script, set the NODE_OPTIONS environment variable to --inspect-brk when starting the debugger:

$ NODE_OPTIONS=--inspect-brk bin/run hello:org -u myOrg@example.com
  1. Set some breakpoints in your command code
  2. Click on the Debug icon in the Activity Bar on the side of VS Code to open up the Debug view.
  3. In the upper left hand corner of VS Code, verify that the "Attach to Remote" launch configuration has been chosen.
  4. Hit the green play button to the left of the "Attach to Remote" launch configuration window. The debugger should now be suspended on the first line of the program.
  5. Hit the green play button at the top middle of VS Code (this play button will be to the right of the play button that you clicked in step #5). Congrats, you are debugging!
sfdx-plugin
@brightfox/bf-sfdx-utils@oclif/command@oclif/config@oclif/errors@salesforce/command@salesforce/coretslibchalkchange-casemustacheswagger-parser
@everything-registry/sub-chunk-1230
1.0.0

1 year ago