qdx

Salesforce command line for deployments

• Usage
• Commands

Usage

$ npm install -g qdx
$ qdx COMMAND
running command...
$ qdx (-v|--version|version)
qdx/1.4.4 darwin-x64 node-v16.11.1
$ qdx --help [COMMAND]
USAGE
  $ qdx COMMAND
...

Commands

• qdx help [COMMAND]
• qdx package PACKAGENAME [COMMIT1] [COMMIT2]
• qdx snippet

qdx help [COMMAND]

display help for qdx

USAGE
  $ qdx help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

qdx package PACKAGENAME [COMMIT1] [COMMIT2]

To build a package to use with sfdx retrieve/deploy commands.

USAGE
  $ qdx package PACKAGENAME [COMMIT1] [COMMIT2]

OPTIONS
  -d, --deploy                 Deploys source already retrieved.
  -h, --help                   show CLI help
  -p, --path=path              Path to app directory or csv file.
  -r, --retrieve               Retrieve source based on YAML configuration.
  -s, --start                  Start a new package. Will create YAML file if not already exist.
  -u, --username=username
  --checkonly                  Set to true for deployment validation
  --csv                        Build metadata components based on a csv file.
  --delete                     Delete the specific components listed in the yaml file.
  --diff                       Build metadata components by running a diff.
  --diffwithbase=diffwithbase  Components added in current branch based on diff with base.
  --dir                        Build metadata components based on directory contents.
  --fill                       Set to true to include all metadata for types listed in yaml.
  --full                       Set to true to get a complete list of all metadata available.
  --installedpackage
  --projectpath=projectpath    Base path for the project code.
  --version=version            API version to use for SFDX
  --yaml                       Build metadata components based on a yml file.

DESCRIPTION
  ...
  # To Start a new package
  qdx package [packageName] --start

See code: src/commands/package.js

qdx snippet

Describe the command here

USAGE
  $ qdx snippet

OPTIONS
  -a, --alias=alias  (required) Alias for the snippet
  -h, --help         show CLI help
  -p, --path=path    (required) Path to file that needs to be converted to snippet.

DESCRIPTION
  ...
  Extra documentation goes here

See code: src/commands/snippet.js