b2warchetypes

bit2win archetype manager plugin for sfdx projects

System requirement

The functionality is released as a sfdx plugins. In order to work the following requirements must be met:

1. Node installed
2. yarn installed npm install -g yarn
3. TypeScript installed npm install -g typescript
4. Salesforce CLI 7.80 installed https://developer.salesforce.com/tools/sfdxcli. There are some known issues with the 7.90 version, please install a previous version
5. Salesforce sfdx Data-Move-Utility plugin installed. Follow details here https://github.com/forcedotcom/SFDX-Data-Move-Utility

Installation

$ sfdx plugins:install b2warchetype
$ sfdx b2warchetypes:COMMAND
running command...
$ sfdx b2warchetypes --help [COMMAND]
USAGE
  $ sfdx b2warchetypes:COMMAND
...

Commands

1. ExportAll

sfdx b2warchetypes:exportall [-u <string>] [-d] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Export All Archetypes source locally from passed sfdx org alias

USAGE
  $ sfdx b2warchetypes:exportall [-u <string>] [-d] [--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
  -d, --debug                                                                       enables debug logging
  --json                                                                            format output as json
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level

2. Save

sfdx b2warchetypes:save -n <string> [-d] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Save archetype bundle locally

USAGE
  $ sfdx b2warchetypes:save -n <string> [-d] [--json] [--loglevel
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -d, --debug                                                                       enables debug logging
  -n, --name=name                                                                   (req) Name of the archetype
  --json                                                                            format output as json
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level

3. Deploy

sfdx b2warchetypes:deploy [-u <string>] [-d] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Deploy bit2win archetypes to target sfdx organization as data

USAGE
  $ sfdx b2warchetypes:deploy [-u <string>] [-d] [--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
  -d, --debug                                                                       enables debug logging
  --json                                                                            format output as json
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level

4. CreateArtifact

sfdx b2warchetypes:createartifact [-u <string>] [-d] [-t] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Create artifact folder with csv data  for external deployment tools

USAGE
  $ sfdx b2warchetypes:createartifact [-u <string>] [-d] [-t] [--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
  -d, --debug                                           enables debug logging
  -t, --timestamp                                       append timestamp to artifact folder to manage uniqueness
  --json                                                format output as json
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level

5. Create (Beta)

The create command has a set of subcommands that allow the creation of archetype related entities from scratch, building the file bundle step by step

V1.2.0: Create command is at ALPHA in this version, correct behaviour is not guaranteed so it has been excluded from read me until next minor release