Skip to content

Latest commit

 

History

History
427 lines (307 loc) · 23.9 KB

README.md

File metadata and controls

427 lines (307 loc) · 23.9 KB
Raw

sfdx-waw-plugin

A plugin for the Salesforce CLI built by Wade Wegner and containing a lot of helpful commands.

Setup

Install from source

  1. Install the SDFX CLI.
  2. Clone the repository: git clone [email protected]:wadewegner/sfdx-waw-plugin.git
  3. Install npm modules: npm install
  4. Link the plugin: sfdx plugins:link .

Install as plugin

  1. Install plugin: sfdx plugins:install sfdx-waw-plugin

sfdx-waw-plugin waw:apex:log:latest [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

get the latest apex log

USAGE
  $ sfdx-waw-plugin waw:apex:log:latest [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal]

OPTIONS
  -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)  [default: warn] logging level for this command invocation

See code: src/commands/waw/apex/log/latest.ts

sfdx-waw-plugin waw:auth:username:login -u <string> [-r <url>] [-p <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

authorize an org using the username password flow

USAGE
  $ sfdx-waw-plugin waw:auth:username:login -u <string> [-r <url>] [-p <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal]

OPTIONS
  -p, --password=password                         password for org - it is recommended to not set this flag and use the
                                                  prompt

  -r, --instanceurl=instanceurl                   the login URL of the instance the org lives on

  -u, --username=username                         (required) username for org

  --json                                          format output as json

  --loglevel=(trace|debug|info|warn|error|fatal)  [default: warn] logging level for this command invocation

See code: src/commands/waw/auth/username/login.ts

sfdx-waw-plugin waw:codeclean:check -i <string> [--json] [--loglevel trace|debug|info|warn|error|fatal]

check the status of the code clean service running against your org

USAGE
  $ sfdx-waw-plugin waw:codeclean:check -i <string> [--json] [--loglevel trace|debug|info|warn|error|fatal]

OPTIONS
  -i, --id=id                                     (required) job id for the code clean service
  --json                                          format output as json
  --loglevel=(trace|debug|info|warn|error|fatal)  [default: warn] logging level for this command invocation

See code: src/commands/waw/codeclean/check.ts

sfdx-waw-plugin waw:codeclean:results -i <string> [--json] [--loglevel trace|debug|info|warn|error|fatal]

get the results of the code clean service running against your org

USAGE
  $ sfdx-waw-plugin waw:codeclean:results -i <string> [--json] [--loglevel trace|debug|info|warn|error|fatal]

OPTIONS
  -i, --id=id                                     (required) job id for the code clean service
  --json                                          format output as json
  --loglevel=(trace|debug|info|warn|error|fatal)  [default: warn] logging level for this command invocation

See code: src/commands/waw/codeclean/results.ts

sfdx-waw-plugin waw:codeclean:start [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

check the status of the code clean service running against your org

USAGE
  $ sfdx-waw-plugin waw:codeclean:start [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal]

OPTIONS
  -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)  [default: warn] logging level for this command invocation

See code: src/commands/waw/codeclean/start.ts

sfdx-waw-plugin waw:connectedapp:create -n <string> [-l <string>] [-r] [-c <string>] [-d <string>] [-s <string>] [-e <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

create a connected app in your org

USAGE
  $ sfdx-waw-plugin waw:connectedapp:create -n <string> [-l <string>] [-r] [-c <string>] [-d <string>] [-s <string>] [-e 
  <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

OPTIONS
  -c, --callbackurl=callbackurl                   callbackUrl (default is "sfdx://success")
  -d, --description=description                   connected app description
  -e, --contactemail=contactemail                 connected app contact email
  -l, --label=label                               connected app label
  -n, --name=name                                 (required) connected app name
  -r, --certificate                               create and register a certificate

  -s, --scopes=scopes                             scopes separated by commas (defaut: Basic, Api, Web, RefreshToken;
                                                  valid: Basic, Api, Web, Full, Chatter, CustomApplications,
                                                  RefreshToken, OpenID, CustomPermissions, Wave, Eclair)

  -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)  [default: warn] logging level for this command invocation

See code: src/commands/waw/connectedapp/create.ts

sfdx-waw-plugin waw:connectedapp:list -n <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

list the connected apps in your org

USAGE
  $ sfdx-waw-plugin waw:connectedapp:list -n <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal]

OPTIONS
  -n, --connectedappname=connectedappname         (required) connectedapp.list.flags.connectedappname
  -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)  [default: warn] logging level for this command invocation

See code: src/commands/waw/connectedapp/list.ts

sfdx-waw-plugin waw:org:share -e <email> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

share a scratch org with someone via email

USAGE
  $ sfdx-waw-plugin waw:org:share -e <email> [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal]

OPTIONS
  -e, --emailaddress=emailaddress                 (required) email address of the scratch org recipient
  -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)  [default: warn] logging level for this command invocation

See code: src/commands/waw/org/share.ts

sfdx-waw-plugin waw:package2:update -d <string> [-i <id>] [-n <string>] [-v <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

update the sfdx-project.json with package2 info

USAGE
  $ sfdx-waw-plugin waw:package2:update -d <string> [-i <id>] [-n <string>] [-v <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal]

OPTIONS
  -d, --packagedirectory=packagedirectory         (required) package directory getting updated
  -i, --id=id                                     id of package
  -n, --versionnumber=versionnumber               version number of package
  -v, --versionname=versionname                   version name of package
  --json                                          format output as json
  --loglevel=(trace|debug|info|warn|error|fatal)  [default: warn] logging level for this command invocation

See code: src/commands/waw/package2/update.ts

sfdx-waw-plugin waw:project:display [-p] [--json] [--loglevel trace|debug|info|warn|error|fatal]

USAGE
  $ sfdx-waw-plugin waw:project:display [-p] [--json] [--loglevel trace|debug|info|warn|error|fatal]

OPTIONS
  -p, --packagedirectories                        list package directories
  --json                                          format output as json
  --loglevel=(trace|debug|info|warn|error|fatal)  [default: warn] logging level for this command invocation

See code: src/commands/waw/project/display.ts

sfdx-waw-plugin waw:project:pdir:create [-p <string>] [-d] [--json] [--loglevel trace|debug|info|warn|error|fatal]

create a package directory for the project definition

USAGE
  $ sfdx-waw-plugin waw:project:pdir:create [-p <string>] [-d] [--json] [--loglevel trace|debug|info|warn|error|fatal]

OPTIONS
  -d, --default                                   sets default
  -p, --path=path                                 path for default package directory
  --json                                          format output as json
  --loglevel=(trace|debug|info|warn|error|fatal)  [default: warn] logging level for this command invocation

See code: src/commands/waw/project/pdir/create.ts

sfdx-waw-plugin waw:project:pdir:delete [-p <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

delete a package directory from the project definition

USAGE
  $ sfdx-waw-plugin waw:project:pdir:delete [-p <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

OPTIONS
  -p, --path=path                                 path for default package directory
  --json                                          format output as json
  --loglevel=(trace|debug|info|warn|error|fatal)  [default: warn] logging level for this command invocation

See code: src/commands/waw/project/pdir/delete.ts

sfdx-waw-plugin waw:project:pdir:set [-p <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

set the default package directory

USAGE
  $ sfdx-waw-plugin waw:project:pdir:set [-p <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

OPTIONS
  -p, --path=path                                 path for default package directory
  --json                                          format output as json
  --loglevel=(trace|debug|info|warn|error|fatal)  [default: warn] logging level for this command invocation

See code: src/commands/waw/project/pdir/set.ts

sfdx-waw-plugin waw:source:create -p <string> [--json] [--loglevel trace|debug|info|warn|error|fatal]

create a manifest file for your open source project

USAGE
  $ sfdx-waw-plugin waw:source:create -p <string> [--json] [--loglevel trace|debug|info|warn|error|fatal]

OPTIONS
  -p, --path=path                                 (required) path for your source
  --json                                          format output as json
  --loglevel=(trace|debug|info|warn|error|fatal)  [default: warn] logging level for this command invocation

See code: src/commands/waw/source/create.ts

sfdx-waw-plugin waw:source:oss -r <string> -p <string> [-b <string> | -t <string>] [-s <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

sasily pulls in open source from a Github repository

USAGE
  $ sfdx-waw-plugin waw:source:oss -r <string> -p <string> [-b <string> | -t <string>] [-s <string>] [--json] 
  [--loglevel trace|debug|info|warn|error|fatal]

OPTIONS
  -b, --branch=branch                             [default: master] git repository branch
  -p, --path=path                                 (required) path for downloaded source
  -r, --repository=repository                     (required) git repository (e.g. "wadewegner/Strike-Components")
  -s, --server=server                             [default: github.com] git host server url
  -t, --tag=tag                                   git repository tag
  --json                                          format output as json
  --loglevel=(trace|debug|info|warn|error|fatal)  [default: warn] logging level for this command invocation

See code: src/commands/waw/source/oss.ts

sfdx-waw-plugin waw:static:create -n <string> -t <string> -d <directory> [--json] [--loglevel trace|debug|info|warn|error|fatal]

create a generic static resource

USAGE
  $ sfdx-waw-plugin waw:static:create -n <string> -t <string> -d <directory> [--json] [--loglevel 
  trace|debug|info|warn|error|fatal]

OPTIONS
  -d, --outputdir=outputdir                       (required) folder for saving the created files
  -n, --name=name                                 (required) static resource name

  -t, --type=type                                 (required) static resource type (application/javascript,
                                                  text/javascript, application/xml, text/xml, text/css, text/plain,
                                                  etc.)

  --json                                          format output as json

  --loglevel=(trace|debug|info|warn|error|fatal)  [default: warn] logging level for this command invocation

See code: src/commands/waw/static/create.ts

sfdx-waw-plugin waw:trace:create [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

create trace flag

USAGE
  $ sfdx-waw-plugin waw:trace:create [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal]

OPTIONS
  -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)  [default: warn] logging level for this command invocation

See code: src/commands/waw/trace/create.ts

sfdx-waw-plugin waw:trace:delete [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

delete trace flag

USAGE
  $ sfdx-waw-plugin waw:trace:delete [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal]

OPTIONS
  -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)  [default: warn] logging level for this command invocation

See code: src/commands/waw/trace/delete.ts

sfdx-waw-plugin waw:trace:list [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

list trace flags

USAGE
  $ sfdx-waw-plugin waw:trace:list [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal]

OPTIONS
  -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)  [default: warn] logging level for this command invocation

See code: src/commands/waw/trace/list.ts

sfdx-waw-plugin waw:workbench:open [-s <string> -t <string>] [-r <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

open workbench using the current target username

USAGE
  $ sfdx-waw-plugin waw:workbench:open [-s <string> -t <string>] [-r <string>] [-u <string>] [--apiversion <string>] 
  [--json] [--loglevel trace|debug|info|warn|error|fatal]

OPTIONS
  -r, --urlonly=urlonly                                urlonly
  -s, --setdefaultworkbenchurl=setdefaultworkbenchurl  store the workbench url as default
  -t, --targetworkbenchurl=targetworkbenchurl          target workbench url

  -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)       [default: warn] logging level for this command invocation

See code: src/commands/waw/workbench/open.ts