flosum-sfdx-plugin v0.4.6-0

flosum-sfdx-plugin

sfdx-cli plugin for Flosum package

• Debugging your plugin

$ npm install -g flosum-sfdx-plugin
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
flosum-sfdx-plugin/0.4.6-0 linux-x64 node-v22.9.0
$ sfdx --help [COMMAND]
USAGE
  $ sfdx COMMAND
...

• sfdx flosum:branch:clone -r <string> -b <string> -p <string> [-s] [-d] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx flosum:branch:create -r <string> -b <string> -p <string> [-s] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx flosum:branch:list -r <string> [-a] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx flosum:org:inspect [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx flosum:repository:clone -r <string> -p <string> [-i <string>] [-e <string>] [-d] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx flosum:repository:list [-a] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx flosum:source:pull -r <string> -b <string> -p <string> [-c] [-d] [-t] [-s] [-t <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx flosum:source:push -s <string> [-r <string>] [-b <string>] [-c] [-d] [-s] [-t <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

sfdx flosum:branch:clone -r <string> -b <string> -p <string> [-s] [-d] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

сlone a branch from the specified repository

сlone a branch from the specified repository

USAGE
  $ sfdx flosum:branch:clone -r <string> -b <string> -p <string> [-s] [-d] [-v <string>] [-u <string>] [--apiversion 
  <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -b, --branch=branch                                                               (required) branch name
  -d, --debug                                                                       enable debug log

  -p, --targetpath=targetpath                                                       (required) path to the target folder
                                                                                    where the data will be saved

  -r, --repository=repository                                                       (required) repository name

  -s, --default-structure                                                           allow automatic creation of required
                                                                                    folder structure

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

  -v, --targetdevhubusername=targetdevhubusername                                   username or alias for the dev hub
                                                                                    org; overrides default dev hub 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 flosum:branch:clone --targetusername myOrg@example.com --targetdevhubusername devhub@org.com 
  --repository=repository --branch=branch --targetpath=targetpath
  $ sfdx flosum:branch:clone --repository=repository --branch=branch --targetpath=force-app/repository/branch

sfdx flosum:branch:create -r <string> -b <string> -p <string> [-s] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

create branch in specified repository

create branch in specified repository

USAGE
  $ sfdx flosum:branch:create -r <string> -b <string> -p <string> [-s] [-v <string>] [-u <string>] [--apiversion 
  <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -b, --branch=branch                                                               (required) branch name

  -p, --targetpath=targetpath                                                       (required) path to the target folder
                                                                                    where the data will be saved

  -r, --repository=repository                                                       (required) repository name

  -s, --default-structure                                                           allow automatic creation of required
                                                                                    folder structure

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

  -v, --targetdevhubusername=targetdevhubusername                                   username or alias for the dev hub
                                                                                    org; overrides default dev hub 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 flosum:branch:create --targetusername myOrg@example.com --targetdevhubusername devhub@org.com 
  --repository=repository --branch=branch --targetpath=targetpath
  $ sfdx flosum:branch:create --repository=repository --branch=branch --targetpath=force-app/repository/branch

sfdx flosum:branch:list -r <string> [-a] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

get list of branches in specified repository (default only returns 10 results)

get list of branches in specified repository (default only returns 10 results)

USAGE
  $ sfdx flosum:branch:list -r <string> [-a] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -a, --all                                                                         return all branches
  -r, --repository=repository                                                       (required) repository name

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

  -v, --targetdevhubusername=targetdevhubusername                                   username or alias for the dev hub
                                                                                    org; overrides default dev hub 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 flosum:branch:list --targetusername myOrg@example.com --targetdevhubusername devhub@org.com 
  --repository=repository
  $ sfdx flosum:branch:list --repository=repository --all

sfdx flosum:org:inspect [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

check org for valid Flosum package license

check org for valid Flosum package license

USAGE
  $ sfdx flosum:org:inspect [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

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

  -v, --targetdevhubusername=targetdevhubusername                                   username or alias for the dev hub
                                                                                    org; overrides default dev hub 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

sfdx flosum:repository:clone -r <string> -p <string> [-i <string>] [-e <string>] [-d] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

сlone components from the specified repository

сlone components from the specified repository

USAGE
  $ sfdx flosum:repository:clone -r <string> -p <string> [-i <string>] [-e <string>] [-d] [-v <string>] [-u <string>] 
  [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -d, --debug                                                                       enable debug log

  -e, --exclude=exclude                                                             list of components excluded in
                                                                                    cloning

  -i, --include=include                                                             list of components included in
                                                                                    cloning

  -p, --targetpath=targetpath                                                       (required) path to the target folder
                                                                                    where the data will be saved

  -r, --repository=repository                                                       (required) repository name

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

  -v, --targetdevhubusername=targetdevhubusername                                   username or alias for the dev hub
                                                                                    org; overrides default dev hub 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 flosum:repository:clone --targetusername myOrg@example.com --targetdevhubusername devhub@org.com 
  --repository=repository --targetpath=targetpath
  $ sfdx flosum:repository:clone --repository=repository --targetpath=force-app/repository

sfdx flosum:repository:list [-a] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

get list of repositories (default only returns 10 results)

get list of repositories (default only returns 10 results)

USAGE
  $ sfdx flosum:repository:list [-a] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -a, --all                                                                         return all repositories

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

  -v, --targetdevhubusername=targetdevhubusername                                   username or alias for the dev hub
                                                                                    org; overrides default dev hub 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 flosum:repository:list --targetusername myOrg@example.com --targetdevhubusername devhub@org.com
  $ sfdx flosum:repository:list --all

sfdx flosum:source:pull -r <string> -b <string> -p <string> [-c] [-d] [-t] [-s] [-t <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

pull components to the source folder from the specified branch

pull components to the source folder from the specified branch

USAGE
  $ sfdx flosum:source:pull -r <string> -b <string> -p <string> [-c] [-d] [-t] [-s] [-t <string>] [-v <string>] [-u 
  <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -b, --branch=branch                                                               (required) branch name

  -c, --custom-path                                                                 flag indicates that specific path is
                                                                                    used without specifying the
                                                                                    repository name and branch in the
                                                                                    path

  -d, --debug                                                                       enable debug log

  -p, --targetpath=targetpath                                                       (required) path to the target folder
                                                                                    where the data will be saved

  -r, --repository=repository                                                       (required) repository name

  -s, --sync                                                                        sync up the current branch with the
                                                                                    remote, this would clear out the
                                                                                    local changes

  -t, --clone                                                                       for internal use, specifies that
                                                                                    pull is called after cloning

  -t, --timestamp=timestamp                                                         for internal use, specifies that
                                                                                    sending date for temporary folder

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

  -v, --targetdevhubusername=targetdevhubusername                                   username or alias for the dev hub
                                                                                    org; overrides default dev hub 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 flosum:source:pull --targetusername myOrg@example.com --repository=repository --branch=branch 
  --targetpath=targetpath
  $ sfdx flosum:source:pull --repository=repository --branch=branch --targetpath=force-app/repository/branch

sfdx flosum:source:push -s <string> [-r <string>] [-b <string>] [-c] [-d] [-s] [-t <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

push components from the source folder to the specified branch

push components from the source folder to the specified branch

USAGE
  $ sfdx flosum:source:push -s <string> [-r <string>] [-b <string>] [-c] [-d] [-s] [-t <string>] [-v <string>] [-u 
  <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -b, --branch=branch                                                               branch name

  -c, --custom-path                                                                 flag indicates that specific path is
                                                                                    used without specifying the
                                                                                    repository name and branch in the
                                                                                    path

  -d, --debug                                                                       enable debug log

  -r, --repository=repository                                                       repository name

  -s, --sourcepath=sourcepath                                                       (required) path to the source data
                                                                                    folder

  -s, --sync                                                                        sync up the current branch with the
                                                                                    remote, this would delete components
                                                                                    that exist on the remote

  -t, --timestamp=timestamp                                                         for internal use, specifies that
                                                                                    sending date for temporary folder

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

  -v, --targetdevhubusername=targetdevhubusername                                   username or alias for the dev hub
                                                                                    org; overrides default dev hub 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 flosum:source:push --targetusername username --repository=repository --branch=branch --sourcepath=sourcepath
  sfdx flosum:source:push --targetdevhubusername devhub@org.com --repository=repository --branch=branch 
  --sourcepath=force-app/repository/branch

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

2. Set some breakpoints in your command code
3. Click on the Debug icon in the Activity Bar on the side of VS Code to open up the Debug view.
4. In the upper left hand corner of VS Code, verify that the "Attach to Remote" launch configuration has been chosen.
5. 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.
6. 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!