create-scratch

A SFDX Plugin to create custom scratch orgs and automatically install dependencies. Also allows pushing source to org after creation.

Installation

$ npm install -g create-scratch

$ npm install -g @glaz-techfi/create-scratch
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
@glaz-techfi/create-scratch/0.8.0 linux-x64 node-v16.17.0
$ sfdx --help [COMMAND]
USAGE
  $ sfdx COMMAND
...

$ npm install -g create-scratch
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
create-scratch/0.5.0 win32-ia32 node-v14.17.0
$ sfdx --help [COMMAND]
USAGE
  $ sfdx COMMAND
...

• sfdx dev:config:init [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx dev:scratch:create [-n <string>] [-d <integer>] [-p] [-c <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

sfdx dev:config:init [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Initialises a configuration file for scratch org construction.

USAGE
  $ sfdx dev:config:init [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  --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/dev/config/init.ts

sfdx dev:scratch:create [-n <string>] [-d <integer>] [-p] [-c <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Create a custom scratch org and install the required packages for your projet. Is also able to automatically push sources to the org

USAGE
  $ sfdx dev:scratch:create [-n <string>] [-d <integer>] [-p] [-c <string>] [-v <string>] [-u <string>] [--apiversion 
  <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -c, --conf=conf                                                                   overrides default config file
  -d, --duration=duration                                                           duration of scratch org
  -n, --name=name                                                                   created scratch org name
  -p, --push                                                                        set to push local sources to org

  -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

See code: src/commands/dev/scratch/create.ts

• sfdx scratch:create [-n <string>] [-d <integer>] [-p] [-f <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

sfdx scratch:create [-n <string>] [-d <integer>] [-p] [-f <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Create a custom scratch org and install the required packages for your projet. Is also able to automatically push sources to the org

USAGE
  $ sfdx scratch:create [-n <string>] [-d <integer>] [-p] [-f <string>] [-v <string>] [-u <string>] [--apiversion 
  <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -d, --duration=duration                                                           duration of scratch org

  -f, --file=file                                                                   Set to give additionnal config file
                                                                                    (for package passwords for examples)

  -n, --name=name                                                                   created scratch org name

  -p, --push                                                                        Set to push local sources to org

  -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

See code: src/commands/scratch/create.ts