0.2.4 • Published 1 year ago
@steampunk/sfdx-steampunk-package v0.2.4
@steampunk/sfdx-steampunk-package
Install
sfdx plugins:install @steampunk/sfdx-steampunk-package
Contributing
See CONTRIBUTING.md
Commands
$ npm install -g @steampunk/sfdx-steampunk-package
$ sfdx COMMAND
running command...
$ sfdx (--version|-v)
@steampunk/sfdx-steampunk-package/0.2.3 win32-x64 node-v18.12.1
$ sfdx --help [COMMAND]
USAGE
$ sfdx COMMAND
...
$ npm install -g @steampunk/sfdx-steampunk-package
$ sfdx COMMAND
running command...
$ sfdx (--version|-v)
@steampunk/sfdx-steampunk-package/0.2.2 win32-x64 node-v18.12.1
$ sfdx --help [COMMAND]
USAGE
$ sfdx COMMAND
...
$ npm install -g @steampunk/sfdx-steampunk-package
$ sfdx COMMAND
running command...
$ sfdx (--version|-v)
@steampunk/sfdx-steampunk-package/0.2.1 win32-x64 node-v18.12.1
$ sfdx --help [COMMAND]
USAGE
$ sfdx COMMAND
...
sfdx punk:package:dependencies:install [-a all|package] [-b <string>] [-k <string>] [--noprecheck] [-r] [-b <minutes>] [-s AllUsers|AdminsOnly] [-t DeprecateOnly|Mixed|Delete] [-w <minutes>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx punk:package:version:cleanup -p <string> -s <string> [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx punk:package:dependencies:install [-a all|package] [-b <string>] [-k <string>] [--noprecheck] [-r] [-b <minutes>] [-s AllUsers|AdminsOnly] [-t DeprecateOnly|Mixed|Delete] [-w <minutes>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Install dependent packages for a sfdx project
USAGE
$ sfdx punk:package:dependencies:install [-a all|package] [-b <string>] [-k <string>] [--noprecheck] [-r] [-b <minutes>] [-s
AllUsers|AdminsOnly] [-t DeprecateOnly|Mixed|Delete] [-w <minutes>] [-v <string>] [-u <string>] [--apiversion
<string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-a, --apexcompile=(all|package)
Compile all Apex in the org and package, or only Apex in the package; unlocked packages only
-b, --branch=<value>
Package branch to consider when specifiyng a Package/VersionNumber combination
-b, --publishwait=<value>
[default: 10 minutes] number of minutes to wait for subscriber package version ID to become available in the target
org
-k, --installationkeys=<value>
Installation keys for key-protected packages
-r, --noprompt
Do not prompt for confirmation
-s, --securitytype=(AllUsers|AdminsOnly)
[default: AdminsOnly] security access type for the installed package (deprecation notice: The default --securitytype
value will change from AllUsers to AdminsOnly in v47.0 or later.)
-t, --upgradetype=(DeprecateOnly|Mixed|Delete)
[default: Mixed] the upgrade type for the package installation; available only for unlocked packages
-u, --targetusername=<value>
username or alias for the target org; overrides default target org
-v, --targetdevhubusername=<value>
username or alias for the dev hub org; overrides default dev hub org
-w, --wait=<value>
[default: 10 minutes] number of minutes to wait for installation status
--apiversion=<value>
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
--noprecheck
Install all packages
DESCRIPTION
Install dependent packages for a sfdx project
Provide a MAJOR.MINOR.PATCH selector to identify which versions to delete
Only non-released versions matching the MAJOR.MINOR.PATCH selector will be deleted
EXAMPLES
$ punk:package:dependencies:install -u MyScratchOrg -v MyDevHub
$ punk:package:dependencies:install -u MyScratchOrg -v MyDevHub -k "MyPackage1Alias:MyPackage1Key,MyPackage2Alias:MyPackage2Key" -b "DEV"
$ punk:package:dependencies:install -u MyScratchOrg -v MyDevHub -k "MyPackage1Alias:MyPackage1Key,MyPackage2Alias:MyPackage2Key" -b "DEV"
See code: src/commands/punk/package/dependencies/install.ts
sfdx punk:package:version:cleanup -p <string> -s <string> [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Use this command to cleanup old package versions
USAGE
$ sfdx punk:package:version:cleanup -p <string> -s <string> [-v <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-p, --package=<value> (required) Package Id
-s, --selector=<value> (required) major.minor.patch
-v, --targetdevhubusername=<value> username or alias for the dev hub
org; overrides default dev hub org
--apiversion=<value> 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
DESCRIPTION
Use this command to cleanup old package versions
Provide a MAJOR.MINOR.PATCH selector to identify which versions to delete
Only non-released versions matching the MAJOR.MINOR.PATCH selector will be deleted
EXAMPLES
$ sfdx punk:package:version:cleanup -p 0Hoxx00000000CqCAI -s 2.10.0
See code: src/commands/punk/package/version/cleanup.ts
sfdx punk:package:dependencies:install [-a all|package] [-b <string>] [-k <string>] [--noprecheck] [-r] [-b <minutes>] [-s AllUsers|AdminsOnly] [-t DeprecateOnly|Mixed|Delete] [-w <minutes>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx punk:package:version:cleanup -p <string> -s <string> [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx punk:package:dependencies:install [-a all|package] [-b <string>] [-k <string>] [--noprecheck] [-r] [-b <minutes>] [-s AllUsers|AdminsOnly] [-t DeprecateOnly|Mixed|Delete] [-w <minutes>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Install dependent packages for a sfdx project
USAGE
$ sfdx punk:package:dependencies:install [-a all|package] [-b <string>] [-k <string>] [--noprecheck] [-r] [-b <minutes>] [-s
AllUsers|AdminsOnly] [-t DeprecateOnly|Mixed|Delete] [-w <minutes>] [-v <string>] [-u <string>] [--apiversion
<string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-a, --apexcompile=(all|package)
Compile all Apex in the org and package, or only Apex in the package; unlocked packages only
-b, --branch=<value>
Package branch to consider when specifiyng a Package/VersionNumber combination
-b, --publishwait=<value>
[default: 10 minutes] number of minutes to wait for subscriber package version ID to become available in the target
org
-k, --installationkeys=<value>
Installation keys for key-protected packages
-r, --noprompt
Do not prompt for confirmation
-s, --securitytype=(AllUsers|AdminsOnly)
[default: AdminsOnly] security access type for the installed package (deprecation notice: The default --securitytype
value will change from AllUsers to AdminsOnly in v47.0 or later.)
-t, --upgradetype=(DeprecateOnly|Mixed|Delete)
[default: Mixed] the upgrade type for the package installation; available only for unlocked packages
-u, --targetusername=<value>
username or alias for the target org; overrides default target org
-v, --targetdevhubusername=<value>
username or alias for the dev hub org; overrides default dev hub org
-w, --wait=<value>
[default: 10 minutes] number of minutes to wait for installation status
--apiversion=<value>
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
--noprecheck
Install all packages
DESCRIPTION
Install dependent packages for a sfdx project
Provide a MAJOR.MINOR.PATCH selector to identify which versions to delete
Only non-released versions matching the MAJOR.MINOR.PATCH selector will be deleted
EXAMPLES
$ punk:package:dependencies:install -u MyScratchOrg -v MyDevHub
$ punk:package:dependencies:install -u MyScratchOrg -v MyDevHub -k "MyPackage1Alias:MyPackage1Key,MyPackage2Alias:MyPackage2Key" -b "DEV"
$ punk:package:dependencies:install -u MyScratchOrg -v MyDevHub -k "MyPackage1Alias:MyPackage1Key,MyPackage2Alias:MyPackage2Key" -b "DEV"
See code: src/commands/punk/package/dependencies/install.ts
sfdx punk:package:version:cleanup -p <string> -s <string> [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Use this command to cleanup old package versions
USAGE
$ sfdx punk:package:version:cleanup -p <string> -s <string> [-v <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-p, --package=<value> (required) Package Id
-s, --selector=<value> (required) major.minor.patch
-v, --targetdevhubusername=<value> username or alias for the dev hub
org; overrides default dev hub org
--apiversion=<value> 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
DESCRIPTION
Use this command to cleanup old package versions
Provide a MAJOR.MINOR.PATCH selector to identify which versions to delete
Only non-released versions matching the MAJOR.MINOR.PATCH selector will be deleted
EXAMPLES
$ sfdx punk:package:version:cleanup -p 0Hoxx00000000CqCAI -s 2.10.0
See code: src/commands/punk/package/version/cleanup.ts
sfdx punk:package:dependencies:install [-a all|package] [-b <string>] [-k <string>] [--noprecheck] [-r] [-b <minutes>] [-s AllUsers|AdminsOnly] [-t DeprecateOnly|Mixed|Delete] [-w <minutes>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx punk:package:version:cleanup -p <string> -s <string> [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx punk:package:dependencies:install [-a all|package] [-b <string>] [-k <string>] [--noprecheck] [-r] [-b <minutes>] [-s AllUsers|AdminsOnly] [-t DeprecateOnly|Mixed|Delete] [-w <minutes>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Install dependent packages for a sfdx project
USAGE
$ sfdx punk:package:dependencies:install [-a all|package] [-b <string>] [-k <string>] [--noprecheck] [-r] [-b <minutes>] [-s
AllUsers|AdminsOnly] [-t DeprecateOnly|Mixed|Delete] [-w <minutes>] [-v <string>] [-u <string>] [--apiversion
<string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-a, --apexcompile=(all|package)
Compile all Apex in the org and package, or only Apex in the package; unlocked packages only
-b, --branch=<value>
Package branch to consider when specifiyng a Package/VersionNumber combination
-b, --publishwait=<value>
[default: 10 minutes] number of minutes to wait for subscriber package version ID to become available in the target
org
-k, --installationkeys=<value>
Installation keys for key-protected packages
-r, --noprompt
Do not prompt for confirmation
-s, --securitytype=(AllUsers|AdminsOnly)
[default: AdminsOnly] security access type for the installed package (deprecation notice: The default --securitytype
value will change from AllUsers to AdminsOnly in v47.0 or later.)
-t, --upgradetype=(DeprecateOnly|Mixed|Delete)
[default: Mixed] the upgrade type for the package installation; available only for unlocked packages
-u, --targetusername=<value>
username or alias for the target org; overrides default target org
-v, --targetdevhubusername=<value>
username or alias for the dev hub org; overrides default dev hub org
-w, --wait=<value>
[default: 10 minutes] number of minutes to wait for installation status
--apiversion=<value>
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
--noprecheck
Install all packages
DESCRIPTION
Install dependent packages for a sfdx project
Provide a MAJOR.MINOR.PATCH selector to identify which versions to delete
Only non-released versions matching the MAJOR.MINOR.PATCH selector will be deleted
EXAMPLES
$ punk:package:dependencies:install -u MyScratchOrg -v MyDevHub
$ punk:package:dependencies:install -u MyScratchOrg -v MyDevHub -k "MyPackage1Alias:MyPackage1Key,MyPackage2Alias:MyPackage2Key" -b "DEV"
$ punk:package:dependencies:install -u MyScratchOrg -v MyDevHub -k "MyPackage1Alias:MyPackage1Key,MyPackage2Alias:MyPackage2Key" -b "DEV"
See code: src/commands/punk/package/dependencies/install.ts
sfdx punk:package:version:cleanup -p <string> -s <string> [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Use this command to cleanup old package versions
USAGE
$ sfdx punk:package:version:cleanup -p <string> -s <string> [-v <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-p, --package=<value> (required) Package Id
-s, --selector=<value> (required) major.minor.patch
-v, --targetdevhubusername=<value> username or alias for the dev hub
org; overrides default dev hub org
--apiversion=<value> 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
DESCRIPTION
Use this command to cleanup old package versions
Provide a MAJOR.MINOR.PATCH selector to identify which versions to delete
Only non-released versions matching the MAJOR.MINOR.PATCH selector will be deleted
EXAMPLES
$ sfdx punk:package:version:cleanup -p 0Hoxx00000000CqCAI -s 2.10.0