diff --git a/README.md b/README.md index 2732063..974bc1d 100644 --- a/README.md +++ b/README.md @@ -20,62 +20,85 @@ Install npm modules: npm install Link the plugin: sfdx plugins:link . -* [`sfdx texei:package:dependencies:install`](#sfdx-texeipackagedependenciesinstall) -* [`sfdx texei:user:update`](#sfdx-texeiuserupdate) +* [`sfdx texei:package:dependencies:install [-k ] [-b ] [-p ] [-n ] [-w ] [-r] [-v ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-texeipackagedependenciesinstall--k-string--b-string--p-string--n-string--w-number--r--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx texei:user:update [-v ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-texeiuserupdate--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) -## `sfdx texei:package:dependencies:install` +## `sfdx texei:package:dependencies:install [-k ] [-b ] [-p ] [-n ] [-w ] [-r] [-v ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` Install dependent Packages for a sfdx project ``` USAGE - $ sfdx texei:package:dependencies:install + $ sfdx texei:package:dependencies:install [-k ] [-b ] [-p ] [-n ] [-w ] [-r] + [-v ] [-u ] [--apiversion ] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] OPTIONS - -b, --branch=branch the package version’s branch + -b, --branch=branch the package version’s branch - -k, --installationkeys=installationkeys installation key for key-protected packages (format is - 1:MyPackage1Key 2: 3:MyPackage3Key... to allow some packages without - installation key) + -k, --installationkeys=installationkeys installation key for key-protected + packages (format is 1:MyPackage1Key + 2: 3:MyPackage3Key... to allow some + packages without installation key) - -n, --namespaces=namespaces filter package installation by namespace + -n, --namespaces=namespaces filter package installation by + namespace - -r, --noprompt allow Remote Site Settings and Content Security Policy websites to - send or receive data without confirmation + -p, --packages=packages comma-separated list of the packages + to install related dependencies - -u, --targetusername=targetusername username or alias for the target org; overrides default target org + -r, --noprompt allow Remote Site Settings and + Content Security Policy websites to + send or receive data without + confirmation - -v, --targetdevhubusername=targetdevhubusername username or alias for the dev hub org; overrides default dev hub org + -u, --targetusername=targetusername username or alias for the target + org; overrides default target org - -w, --wait=wait number of minutes to wait for installation status (also used for - publishwait). Default is 10 + -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 + -w, --wait=wait number of minutes to wait for + installation status (also used for + publishwait). Default is 10 - --json format output as json + --apiversion=apiversion override the api version used for + api requests made by this command - --loglevel=(trace|debug|info|warn|error|fatal) logging level for this command invocation + --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 EXAMPLE $ texei:package:dependencies:install -u MyScratchOrg -v MyDevHub -k "1:MyPackage1Key 2: 3:MyPackage3Key" -b "DEV" ``` -_See code: [src/commands/texei/package/dependencies/install.ts](https://github.com/texei/texei-sfdx-plugin/blob/v0.0.4/src/commands/texei/package/dependencies/install.ts)_ +_See code: [src/commands/texei/package/dependencies/install.ts](https://github.com/texei/texei-sfdx-plugin/blob/v0.0.5/src/commands/texei/package/dependencies/install.ts)_ -## `sfdx texei:user:update` +## `sfdx texei:user:update [-v ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` Updates the current user of a scratch org ``` USAGE - $ sfdx texei:user:update + $ sfdx texei:user:update [-v ] [-u ] [--apiversion ] [--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, --values=values the = pairs you’re updating - --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) logging level for this command invocation + -u, --targetusername=targetusername username or alias for the target + org; overrides default target org + + -v, --values=values the = pairs you’re + updating + + --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 texei:user:update --targetusername myOrg@example.com --values "LanguageLocaleKey='fr'" @@ -83,5 +106,5 @@ EXAMPLES $ sfdx texei:user:update --values "UserPermissionsKnowledgeUser=true --json" ``` -_See code: [src/commands/texei/user/update.ts](https://github.com/texei/texei-sfdx-plugin/blob/v0.0.4/src/commands/texei/user/update.ts)_ +_See code: [src/commands/texei/user/update.ts](https://github.com/texei/texei-sfdx-plugin/blob/v0.0.5/src/commands/texei/user/update.ts)_ diff --git a/oclif.manifest.json b/oclif.manifest.json new file mode 100644 index 0000000..52f9181 --- /dev/null +++ b/oclif.manifest.json @@ -0,0 +1 @@ +{"version":"0.0.5","commands":{"texei:user:update":{"id":"texei:user:update","description":"Updates the current user of a scratch org","usage":"<%= command.id %> [-v ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"texei-sfdx-plugin","pluginType":"core","aliases":[],"examples":["$ sfdx texei:user:update --targetusername myOrg@example.com --values \"LanguageLocaleKey='fr'\" \nSuccessfully updated record: 005D2A90N8A11SVPE2.","$ sfdx texei:user:update --values \"UserPermissionsKnowledgeUser=true --json\""],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"values":{"name":"values","type":"option","char":"v","description":"the = pairs you’re updating"}},"args":[]},"texei:package:dependencies:install":{"id":"texei:package:dependencies:install","description":"Install dependent Packages for a sfdx project","usage":"<%= command.id %> [-k ] [-b ] [-p ] [-n ] [-w ] [-r] [-v ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"texei-sfdx-plugin","pluginType":"core","aliases":[],"examples":["$ texei:package:dependencies:install -u MyScratchOrg -v MyDevHub -k \"1:MyPackage1Key 2: 3:MyPackage3Key\" -b \"DEV\""],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetdevhubusername":{"name":"targetdevhubusername","type":"option","char":"v","description":"username or alias for the dev hub org; overrides default dev hub org"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"installationkeys":{"name":"installationkeys","type":"option","char":"k","description":"installation key for key-protected packages (format is 1:MyPackage1Key 2: 3:MyPackage3Key... to allow some packages without installation key)","required":false},"branch":{"name":"branch","type":"option","char":"b","description":"the package version’s branch","required":false},"packages":{"name":"packages","type":"option","char":"p","description":"comma-separated list of the packages to install related dependencies","required":false},"namespaces":{"name":"namespaces","type":"option","char":"n","description":"filter package installation by namespace","required":false},"wait":{"name":"wait","type":"option","char":"w","description":"number of minutes to wait for installation status (also used for publishwait). Default is 10","required":false},"noprompt":{"name":"noprompt","type":"boolean","char":"r","description":"allow Remote Site Settings and Content Security Policy websites to send or receive data without confirmation","required":false,"allowNo":false}},"args":[]}}} \ No newline at end of file