diff --git a/.github/workflows/build-deploy-docs.yml b/.github/workflows/build-deploy-docs.yml new file mode 100644 index 0000000..e819a32 --- /dev/null +++ b/.github/workflows/build-deploy-docs.yml @@ -0,0 +1,28 @@ +name: "DOC - Build and deploy with sfdx-hardis" +on: + push: + branches: + - main + - master + +jobs: + # Build & deploy docs + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2.3.4 + # Build doc with sfdx-hardis + - uses: actions/setup-node@v1 + with: + node-version: "12.x" + - run: yarn + - run: yarn prepack + - run: npm i sfdx-cli -g + - run: echo y|sfdx plugins:install sfdx-hardis + - run: sfdx hardis:doc:plugin:generate + # Deploy docs with mkdocs-material + - uses: actions/setup-python@v2 + with: + python-version: 3.x + - run: pip install mkdocs-material mdx_truly_sane_lists json-schema-for-humans + - run: mkdocs gh-deploy --force diff --git a/.gitignore b/.gitignore index 084d559..a983bee 100644 --- a/.gitignore +++ b/.gitignore @@ -11,4 +11,5 @@ node_modules .vscode .DS_Store .nyc_output -project-scratch-def.json \ No newline at end of file +project-scratch-def.json +hardis-report/ diff --git a/docs/commands.md b/docs/commands.md new file mode 100644 index 0000000..9cf6bc4 --- /dev/null +++ b/docs/commands.md @@ -0,0 +1,67 @@ +# Commands + +## texei:contractstatus + +|Command|Title| +|:------|:----------| +|[**texei:contractstatus:value:add**](texei/contractstatus/value/add.md)|add a value to Contract Status picklist| + +## texei:data + +|Command|Title| +|:------|:----------| +|[**texei:data:export**](texei/data/export.md)|export objects' data from org| +|[**texei:data:import**](texei/data/import.md)|import objects' data to org| +|[**texei:data:plan:generate**](texei/data/plan/generate.md)|generate a data plan used to export objects' data from org| + +## texei:org + +|Command|Title| +|:------|:----------| +|[**texei:org:contractfieldhistory:fix**](texei/org/contractfieldhistory/fix.md)|fix Contract Field History Tracking that can't be deployed| +|[**texei:org:shape:extract**](texei/org/shape/extract.md)|[BETA] Extract Org Shape for an org| + +## texei:package + +|Command|Title| +|:------|:----------| +|[**texei:package:dependencies:install**](texei/package/dependencies/install.md)|install dependent Packages for a sfdx project| + +## texei:profile + +|Command|Title| +|:------|:----------| +|[**texei:profile:clean**](texei/profile/clean.md)|clean Profile by removing permissions stored on Permission Set| + +## texei:sharedactivities + +|Command|Title| +|:------|:----------| +|[**texei:sharedactivities:enable**](texei/sharedactivities/enable.md)|Enable Shared Activities| + +## texei:sharingcalc + +|Command|Title| +|:------|:----------| +|[**texei:sharingcalc:recalculate**](texei/sharingcalc/recalculate.md)|recalculate sharing rules| +|[**texei:sharingcalc:resume**](texei/sharingcalc/resume.md)|resumed sharing calculation| +|[**texei:sharingcalc:suspend**](texei/sharingcalc/suspend.md)|suspend sharing calculation| + +## texei:skinnyprofile + +|Command|Title| +|:------|:----------| +|[**texei:skinnyprofile:retrieve**](texei/skinnyprofile/retrieve.md)|export a skinny profile with just package-specific metadata| + +## texei:source + +|Command|Title| +|:------|:----------| +|[**texei:source:customlabel:replace**](texei/source/customlabel/replace.md)|replace custom label value| +|[**texei:source:layouts:cleanorg**](texei/source/layouts/cleanorg.md)|delete unused standard layouts from scratch org| + +## texei:user + +|Command|Title| +|:------|:----------| +|[**texei:user:update**](texei/user/update.md)|updates the current user of a scratch org| diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..c32d2a4 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,91 @@ + +texei-sfdx-plugin +================= + +Texeï's plugin for sfdx + +## Install Plugin + +### Install as plugin + +Install plugin: sfdx plugins:install texei-sfdx-plugin + +### Install from source + +Install the SDFX CLI. + +Clone the repository: git clone https://github.com/texei/texei-sfdx-plugin.git + +Install npm modules: npm install + +Link the plugin: sfdx plugins:link . + + + +## Commands + +### texei:contractstatus + +|Command|Title| +|:------|:----------| +|[**texei:contractstatus:value:add**](texei/contractstatus/value/add.md)|add a value to Contract Status picklist| + +### texei:data + +|Command|Title| +|:------|:----------| +|[**texei:data:export**](texei/data/export.md)|export objects' data from org| +|[**texei:data:import**](texei/data/import.md)|import objects' data to org| +|[**texei:data:plan:generate**](texei/data/plan/generate.md)|generate a data plan used to export objects' data from org| + +### texei:org + +|Command|Title| +|:------|:----------| +|[**texei:org:contractfieldhistory:fix**](texei/org/contractfieldhistory/fix.md)|fix Contract Field History Tracking that can't be deployed| +|[**texei:org:shape:extract**](texei/org/shape/extract.md)|[BETA] Extract Org Shape for an org| + +### texei:package + +|Command|Title| +|:------|:----------| +|[**texei:package:dependencies:install**](texei/package/dependencies/install.md)|install dependent Packages for a sfdx project| + +### texei:profile + +|Command|Title| +|:------|:----------| +|[**texei:profile:clean**](texei/profile/clean.md)|clean Profile by removing permissions stored on Permission Set| + +### texei:sharedactivities + +|Command|Title| +|:------|:----------| +|[**texei:sharedactivities:enable**](texei/sharedactivities/enable.md)|Enable Shared Activities| + +### texei:sharingcalc + +|Command|Title| +|:------|:----------| +|[**texei:sharingcalc:recalculate**](texei/sharingcalc/recalculate.md)|recalculate sharing rules| +|[**texei:sharingcalc:resume**](texei/sharingcalc/resume.md)|resumed sharing calculation| +|[**texei:sharingcalc:suspend**](texei/sharingcalc/suspend.md)|suspend sharing calculation| + +### texei:skinnyprofile + +|Command|Title| +|:------|:----------| +|[**texei:skinnyprofile:retrieve**](texei/skinnyprofile/retrieve.md)|export a skinny profile with just package-specific metadata| + +### texei:source + +|Command|Title| +|:------|:----------| +|[**texei:source:customlabel:replace**](texei/source/customlabel/replace.md)|replace custom label value| +|[**texei:source:layouts:cleanorg**](texei/source/layouts/cleanorg.md)|delete unused standard layouts from scratch org| + +### texei:user + +|Command|Title| +|:------|:----------| +|[**texei:user:update**](texei/user/update.md)|updates the current user of a scratch org| diff --git a/docs/javascripts/gtag.js b/docs/javascripts/gtag.js new file mode 100644 index 0000000..4bb097e --- /dev/null +++ b/docs/javascripts/gtag.js @@ -0,0 +1,27 @@ +/* +location$.subscribe(function(url) { + window.dataLayer = window.dataLayer || []; + function gtag() { + dataLayer.push(arguments); + } + gtag("js", new Date()); + + gtag("config", "G-3DM50255LC"); +}); +*/ +var gtag_id = "G-XXXXXXXXXX"; + +var script = document.createElement("script"); +script.src = "https://www.googletagmanager.com/gtag/js?id=" + gtag_id; +document.head.appendChild(script); + +location$.subscribe(function (url) { + window.dataLayer = window.dataLayer || []; + + function gtag() { + dataLayer.push(arguments); + } + + gtag("js", new Date()); + gtag("config", gtag_id); +}); diff --git a/docs/javascripts/tables.js b/docs/javascripts/tables.js new file mode 100644 index 0000000..513f93e --- /dev/null +++ b/docs/javascripts/tables.js @@ -0,0 +1,6 @@ +document$.subscribe(function () { + var tables = document.querySelectorAll("article table") + tables.forEach(function (table) { + new Tablesort(table) + }) +}) diff --git a/docs/license.md b/docs/license.md new file mode 100644 index 0000000..aa5f25a --- /dev/null +++ b/docs/license.md @@ -0,0 +1 @@ +--8<-- "../LICENSE" diff --git a/docs/overrides/main.html b/docs/overrides/main.html new file mode 100644 index 0000000..3cf4af8 --- /dev/null +++ b/docs/overrides/main.html @@ -0,0 +1,4 @@ +{% extends "base.html" %} + + + diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css new file mode 100644 index 0000000..8503fe4 --- /dev/null +++ b/docs/stylesheets/extra.css @@ -0,0 +1,8 @@ +/* stylelint-disable SelectorFormat */ +.md-typeset__table { + min-width: 100%; +} + +.md-typeset table:not([class]) { + display: table; +} diff --git a/docs/texei/contractstatus/value/add.md b/docs/texei/contractstatus/value/add.md new file mode 100644 index 0000000..d8cde72 --- /dev/null +++ b/docs/texei/contractstatus/value/add.md @@ -0,0 +1,26 @@ + +# texei:contractstatus:value:add + +## Description + +add a value to Contract Status picklist + +## Parameters + +|Name|Type|Description|Default|Required|Options| +|:---|:--:|:----------|:-----:|:------:|:-----:| +|apiname
-a|option|API Name of the Contract Status value to add|||| +|apiversion|option|override the api version used for api requests made by this command|||| +|json|boolean|format output as json|||| +|label
-l|option|label of the Contract Status value to add|||| +|loglevel|option|logging level for this command invocation|warn||trace
debug
info
warn
error
fatal| +|statuscategory
-s|option|Status Category of the Contract Status value to add|Draft||Draft
Activated
InApprovalProcess| +|targetusername
-u|option|username or alias for the target org; overrides default target org|||| + +## Examples + +```shell +sfdx texei:contractstatus:value:add --label 'My New Contract Status Label' --apiname 'My New Contract Status API Name' --targetusername texei +``` + + diff --git a/docs/texei/data/export.md b/docs/texei/data/export.md new file mode 100644 index 0000000..2569e0d --- /dev/null +++ b/docs/texei/data/export.md @@ -0,0 +1,30 @@ + +# texei:data:export + +## Description + +export objects' data from org + +## Parameters + +|Name|Type|Description|Default|Required|Options| +|:---|:--:|:----------|:-----:|:------:|:-----:| +|apiversion|option|override the api version used for api requests made by this command|||| +|dataplan
-p|option|path to data plan file|||| +|json|boolean|format output as json|||| +|loglevel|option|logging level for this command invocation|warn||trace
debug
info
warn
error
fatal| +|objects
-o|option|comma-separated list of objects to export|||| +|outputdir
-d|option|directory where to store files|||| +|targetusername
-u|option|username or alias for the target org; overrides default target org|||| + +## Examples + +```shell +sfdx texei:data:export --objects Account,Contact,MyCustomObject__c --outputdir ./data --targetusername texei +``` + +```shell +sfdx texei:data:export --dataplan ./data/data-plan.json --outputdir ./data --targetusername texei +``` + + diff --git a/docs/texei/data/import.md b/docs/texei/data/import.md new file mode 100644 index 0000000..7c8cef9 --- /dev/null +++ b/docs/texei/data/import.md @@ -0,0 +1,27 @@ + +# texei:data:import + +## Description + +import objects' data to org + +## Parameters + +|Name|Type|Description|Default|Required|Options| +|:---|:--:|:----------|:-----:|:------:|:-----:| +|allornone
-a|boolean|any failed records in a call cause all changes for the call to be rolled back|||| +|apiversion|option|override the api version used for api requests made by this command|||| +|inputdir
-d|option|directory with files to import|||| +|json|boolean|format output as json|||| +|loglevel|option|logging level for this command invocation|warn||trace
debug
info
warn
error
fatal| +|targetusername
-u|option|username or alias for the target org; overrides default target org|||| + +## Examples + +```shell +$ sfdx texei:data:import --inputdir ./data --targetusername texei-scratch + Data imported! + +``` + + diff --git a/docs/texei/data/plan/generate.md b/docs/texei/data/plan/generate.md new file mode 100644 index 0000000..deb953a --- /dev/null +++ b/docs/texei/data/plan/generate.md @@ -0,0 +1,23 @@ + +# texei:data:plan:generate + +## Description + +generate a data plan used to export objects' data from org + +## Parameters + +|Name|Type|Description|Default|Required|Options| +|:---|:--:|:----------|:-----:|:------:|:-----:| +|json|boolean|format output as json|||| +|loglevel|option|logging level for this command invocation|warn||trace
debug
info
warn
error
fatal| +|objects
-o|option|comma-separated list of objects to add to the data plan|||| +|outputdir
-d|option|directory where to store the data plan file|||| + +## Examples + +```shell +$ sfdx texei:data:plan:generate --objects Account,Contact,MyCustomObject__c --outputdir ./data +``` + + diff --git a/docs/texei/org/contractfieldhistory/fix.md b/docs/texei/org/contractfieldhistory/fix.md new file mode 100644 index 0000000..a801fb4 --- /dev/null +++ b/docs/texei/org/contractfieldhistory/fix.md @@ -0,0 +1,25 @@ + +# texei:org:contractfieldhistory:fix + +## Description + +fix Contract Field History Tracking that can't be deployed + +## Parameters + +|Name|Type|Description|Default|Required|Options| +|:---|:--:|:----------|:-----:|:------:|:-----:| +|apiversion|option|override the api version used for api requests made by this command|||| +|json|boolean|format output as json|||| +|loglevel|option|logging level for this command invocation|warn||trace
debug
info
warn
error
fatal| +|targetusername
-u|option|username or alias for the target org; overrides default target org|||| + +## Examples + +```shell +$ sfdx texei:org:contractfieldhistory:fix" +History tracking fixed. + +``` + + diff --git a/docs/texei/org/shape/extract.md b/docs/texei/org/shape/extract.md new file mode 100644 index 0000000..2a33e77 --- /dev/null +++ b/docs/texei/org/shape/extract.md @@ -0,0 +1,25 @@ + +# texei:org:shape:extract + +## Description + +[BETA] Extract Org Shape for an org + +## Parameters + +|Name|Type|Description|Default|Required|Options| +|:---|:--:|:----------|:-----:|:------:|:-----:| +|apiversion|option|override the api version used for api requests made by this command|||| +|json|boolean|format output as json|||| +|loglevel|option|logging level for this command invocation|warn||trace
debug
info
warn
error
fatal| +|outputdir
-d|option|the output directory to store the extracted definition file|config||| +|scope
-s|option|the scope of settings to convert to the scratch definition file|basic||basic
full| +|targetusername
-u|option|username or alias for the target org; overrides default target org|||| + +## Examples + +```shell +$ sfdx texei:org:shape:extract -u bulma@capsulecorp.com" +``` + + diff --git a/docs/texei/package/dependencies/install.md b/docs/texei/package/dependencies/install.md new file mode 100644 index 0000000..801f9fd --- /dev/null +++ b/docs/texei/package/dependencies/install.md @@ -0,0 +1,32 @@ + +# texei:package:dependencies:install + +## Description + +install dependent Packages for a sfdx project + +## Parameters + +|Name|Type|Description|Default|Required|Options| +|:---|:--:|:----------|:-----:|:------:|:-----:| +|apexcompile
-a|option|compile all Apex in the org and package, or only Apex in the package (see force:package:install for default value)|||| +|apiversion|option|override the api version used for api requests made by this command|||| +|branch
-b|option|the package version’s branch|||| +|installationkeys
-k|option|installation key for key-protected packages (format is 1:MyPackage1Key 2: 3:MyPackage3Key... to allow some packages without installation key)|||| +|json|boolean|format output as json|||| +|loglevel|option|logging level for this command invocation|warn||trace
debug
info
warn
error
fatal| +|namespaces
-n|option|filter package installation by namespace|||| +|noprompt
-r|boolean|allow Remote Site Settings and Content Security Policy websites to send or receive data without confirmation|||| +|packages
-p|option|comma-separated list of the packages to install related dependencies|||| +|securitytype
-s|option|security access type for the installed package (see force:package:install for default value)|||| +|targetdevhubusername
-v|option|username or alias for the dev hub org; overrides default dev hub org|||| +|targetusername
-u|option|username or alias for the target org; overrides default target org|||| +|wait
-w|option|number of minutes to wait for installation status (also used for publishwait). Default is 10|||| + +## Examples + +```shell +$ texei:package:dependencies:install -u MyScratchOrg -v MyDevHub -k "1:MyPackage1Key 2: 3:MyPackage3Key" -b "DEV" +``` + + diff --git a/docs/texei/profile/clean.md b/docs/texei/profile/clean.md new file mode 100644 index 0000000..99e5538 --- /dev/null +++ b/docs/texei/profile/clean.md @@ -0,0 +1,31 @@ + +# texei:profile:clean + +## Description + +clean Profile by removing permissions stored on Permission Set + +## Parameters + +|Name|Type|Description|Default|Required|Options| +|:---|:--:|:----------|:-----:|:------:|:-----:| +|json|boolean|format output as json|||| +|keep
-k|option|comma-separated list of profile node permissions that need to be kept. Default: layoutAssignments,loginHours,loginIpRanges,custom,userLicense|||| +|loglevel|option|logging level for this command invocation|warn||trace
debug
info
warn
error
fatal| +|path
-p|option|comma-separated list of profiles, or path to profiles folder. Default: default package directory|||| + +## Examples + +```shell +$ texei:profile:clean -k layoutAssignments,recordTypeVisibilities +``` + +```shell +$ texei:profile:clean -p custom-sfdx-source-folder/main/profiles +``` + +```shell +$ texei:profile:clean -p custom-sfdx-source-folder/main/profiles,source-folder-2/main/profiles/myAdmin.profile-meta.xml +``` + + diff --git a/docs/texei/sharedactivities/enable.md b/docs/texei/sharedactivities/enable.md new file mode 100644 index 0000000..80f3a72 --- /dev/null +++ b/docs/texei/sharedactivities/enable.md @@ -0,0 +1,23 @@ + +# texei:sharedactivities:enable + +## Description + +Enable Shared Activities + +## Parameters + +|Name|Type|Description|Default|Required|Options| +|:---|:--:|:----------|:-----:|:------:|:-----:| +|apiversion|option|override the api version used for api requests made by this command|||| +|json|boolean|format output as json|||| +|loglevel|option|logging level for this command invocation|warn||trace
debug
info
warn
error
fatal| +|targetusername
-u|option|username or alias for the target org; overrides default target org|||| + +## Examples + +```shell +$ sfdx texei:sharedactivities:enable +``` + + diff --git a/docs/texei/sharingcalc/recalculate.md b/docs/texei/sharingcalc/recalculate.md new file mode 100644 index 0000000..31e3b3f --- /dev/null +++ b/docs/texei/sharingcalc/recalculate.md @@ -0,0 +1,26 @@ + +# texei:sharingcalc:recalculate + +## Description + +recalculate sharing rules + +## Parameters + +|Name|Type|Description|Default|Required|Options| +|:---|:--:|:----------|:-----:|:------:|:-----:| +|apiversion|option|override the api version used for api requests made by this command|||| +|json|boolean|format output as json|||| +|loglevel|option|logging level for this command invocation|warn||trace
debug
info
warn
error
fatal| +|scope
-s|option|scope of recalculations|sharingRule||sharingRule| +|targetusername
-u|option|username or alias for the target org; overrides default target org|||| + +## Examples + +```shell +$ sfdx texei:sharingcalc:recalculate" +Recalculated Sharing Rules + +``` + + diff --git a/docs/texei/sharingcalc/resume.md b/docs/texei/sharingcalc/resume.md new file mode 100644 index 0000000..b73c91b --- /dev/null +++ b/docs/texei/sharingcalc/resume.md @@ -0,0 +1,27 @@ + +# texei:sharingcalc:resume + +## Description + +resumed sharing calculation + +## Parameters + +|Name|Type|Description|Default|Required|Options| +|:---|:--:|:----------|:-----:|:------:|:-----:| +|apiversion|option|override the api version used for api requests made by this command|||| +|json|boolean|format output as json|||| +|loglevel|option|logging level for this command invocation|warn||trace
debug
info
warn
error
fatal| +|scope
-s|option|scope of resumed calculations|sharingRule||sharingRule
groupMembership| +|targetusername
-u|option|username or alias for the target org; overrides default target org|||| +|timeout
-t|option|Timeout for the sfdx command, in milliseconds|120000||| + +## Examples + +```shell +$ sfdx texei:sharingcalc:resume" +Sharing calculations resumed + +``` + + diff --git a/docs/texei/sharingcalc/suspend.md b/docs/texei/sharingcalc/suspend.md new file mode 100644 index 0000000..b7d4e3f --- /dev/null +++ b/docs/texei/sharingcalc/suspend.md @@ -0,0 +1,27 @@ + +# texei:sharingcalc:suspend + +## Description + +suspend sharing calculation + +## Parameters + +|Name|Type|Description|Default|Required|Options| +|:---|:--:|:----------|:-----:|:------:|:-----:| +|apiversion|option|override the api version used for api requests made by this command|||| +|json|boolean|format output as json|||| +|loglevel|option|logging level for this command invocation|warn||trace
debug
info
warn
error
fatal| +|scope
-s|option|scope of suspended calculations|sharingRule||sharingRule
groupMembership| +|targetusername
-u|option|username or alias for the target org; overrides default target org|||| +|timeout
-t|option|Timeout for the sfdx command, in milliseconds|120000||| + +## Examples + +```shell +$ sfdx texei:sharingcalc:suspend" +Sharing calculations suspended + +``` + + diff --git a/docs/texei/skinnyprofile/retrieve.md b/docs/texei/skinnyprofile/retrieve.md new file mode 100644 index 0000000..f83ca6d --- /dev/null +++ b/docs/texei/skinnyprofile/retrieve.md @@ -0,0 +1,24 @@ + +# texei:skinnyprofile:retrieve + +## Description + +export a skinny profile with just package-specific metadata + +## Parameters + +|Name|Type|Description|Default|Required|Options| +|:---|:--:|:----------|:-----:|:------:|:-----:| +|apiversion|option|override the api version used for api requests made by this command|||| +|json|boolean|format output as json|||| +|loglevel|option|logging level for this command invocation|warn||trace
debug
info
warn
error
fatal| +|targetusername
-u|option|username or alias for the target org; overrides default target org|||| +|timeout
-t|option|timeout(ms) for profile retrieve (Default: 60000ms)|||| + +## Examples + +```shell +$ texei:skinnyprofile:retrieve -u MyScratchOrg +``` + + diff --git a/docs/texei/source/customlabel/replace.md b/docs/texei/source/customlabel/replace.md new file mode 100644 index 0000000..a90a819 --- /dev/null +++ b/docs/texei/source/customlabel/replace.md @@ -0,0 +1,24 @@ + +# texei:source:customlabel:replace + +## Description + +replace custom label value + +## Parameters + +|Name|Type|Description|Default|Required|Options| +|:---|:--:|:----------|:-----:|:------:|:-----:| +|json|boolean|format output as json|||| +|label
-l|option|custom label to replace|||| +|loglevel|option|logging level for this command invocation|warn||trace
debug
info
warn
error
fatal| +|path
-p|option|path to custom label|||| +|value
-v|option|new custom label|||| + +## Examples + +```shell +$ texei:source:customlabel:replace --label GreatSalesforceBlog --value https://blog.texei.com +``` + + diff --git a/docs/texei/source/layouts/cleanorg.md b/docs/texei/source/layouts/cleanorg.md new file mode 100644 index 0000000..27ce8d8 --- /dev/null +++ b/docs/texei/source/layouts/cleanorg.md @@ -0,0 +1,29 @@ + +# texei:source:layouts:cleanorg + +## Description + +delete unused standard layouts from scratch org + +## Parameters + +|Name|Type|Description|Default|Required|Options| +|:---|:--:|:----------|:-----:|:------:|:-----:| +|apiversion|option|override the api version used for api requests made by this command|||| +|json|boolean|format output as json|||| +|loglevel|option|logging level for this command invocation|warn||trace
debug
info
warn
error
fatal| +|path
-p|option|path to layouts|||| +|targetdevhubusername
-v|option|username or alias for the dev hub org; overrides default dev hub org|||| +|targetusername
-u|option|username or alias for the target org; overrides default target org|||| + +## Examples + +```shell +$ texei:source:layouts:cleanorg +``` + +```shell +$ texei:source:layouts:cleanorg --targetusername myScratchOrg --targetdevhubusername myDevHub +``` + + diff --git a/docs/texei/user/update.md b/docs/texei/user/update.md new file mode 100644 index 0000000..06f7fd5 --- /dev/null +++ b/docs/texei/user/update.md @@ -0,0 +1,33 @@ + +# texei:user:update + +## Description + +updates the current user of a scratch org + +## Parameters + +|Name|Type|Description|Default|Required|Options| +|:---|:--:|:----------|:-----:|:------:|:-----:| +|apiversion|option|override the api version used for api requests made by this command|||| +|json|boolean|format output as json|||| +|loglevel|option|logging level for this command invocation|warn||trace
debug
info
warn
error
fatal| +|targetusername
-u|option|username or alias for the target org; overrides default target org|||| +|values
-v|option|the = pairs you’re updating|||| + +## Examples + +```shell +sfdx texei:user:update --targetusername myOrg@example.com --values "LanguageLocaleKey='fr'" +Successfully updated record: 005D2A90N8A11SVPE2. +``` + +```shell +sfdx texei:user:update --values "UserPermissionsKnowledgeUser=true" --json +``` + +```shell +sfdx texei:user:update --values "LanguageLocaleKey=en_US UserPermissionsMarketingUser=true" --json +``` + + diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..e47facb --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,81 @@ +site_name: Texeï sfdx plugin +site_url: https://texei.github.io/texei-sfdx-plugin +repo_url: https://github.com/texei/texei-sfdx-plugin +edit_uri: tree/master/docs +site_author: Texeï +site_description: Salesforce DX Plugin by Texei. +copyright: >- + Doc generated by sfdx-hardis +theme: + name: material + custom_dir: docs/overrides + features: + - navigation.instant + palette: + primary: light blue +markdown_extensions: + - pymdownx.emoji: + emoji_index: !!python/name:materialx.emoji.twemoji + emoji_generator: !!python/name:materialx.emoji.to_svg + - pymdownx.snippets: + base_path: docs + check_paths: true + - mdx_truly_sane_lists + - attr_list +extra_javascript: + - https://cdnjs.cloudflare.com/ajax/libs/tablesort/5.2.1/tablesort.min.js + - javascripts/tables.js + - javascripts/gtag.js +extra_css: + - stylesheets/extra.css +extra: + social: + - icon: fontawesome/regular/question-circle + link: https://github.com/texei/texei-sfdx-plugin/issues + title: Need help ? Post an issue :) + - icon: fontawesome/brands/github + link: https://github.com/texei/texei-sfdx-plugin + - icon: fontawesome/brands/twitter + link: https://twitter.com/TexeiFrance + generator: false +nav: + - Home: index.md + - Commands: + All commands: commands.md + texei: + contractstatus: + value: + add: texei/contractstatus/value/add.md + data: + export: texei/data/export.md + import: texei/data/import.md + plan: + generate: texei/data/plan/generate.md + org: + contractfieldhistory: + fix: texei/org/contractfieldhistory/fix.md + shape: + extract: texei/org/shape/extract.md + package: + dependencies: + install: texei/package/dependencies/install.md + profile: + clean: texei/profile/clean.md + sharedactivities: + enable: texei/sharedactivities/enable.md + sharingcalc: + recalculate: texei/sharingcalc/recalculate.md + resume: texei/sharingcalc/resume.md + suspend: texei/sharingcalc/suspend.md + skinnyprofile: + retrieve: texei/skinnyprofile/retrieve.md + source: + customlabel: + replace: texei/source/customlabel/replace.md + layouts: + cleanorg: texei/source/layouts/cleanorg.md + user: + update: texei/user/update.md + - License: license.md