npm package: @nimbleams/sfdx-nimbleams
Description: sfdx-nimbleams ==============
Author: Nimble AMS
Latest version: 1.16.0

sfdx-nimbleams
==============

## Usage

### Install

```
# Clone repo
git clone git@github.com:mmsw-ams/src-nmb-sfdxplugin.git

# Change directory
cd src-nmb-sfdxplugin

# Install npm dependencies
npm install

# Link plugin
sf plugins:link .
```

### Run

```
sf nimbleams:data:import -u USERNAME_OR_ALIAS -f ./data/insertOrder.json
```

____

[![Version](https://img.shields.io/npm/v/@nimbleams/sfdx-nimbleams.svg)](https://npmjs.org/package/@nimbleams/sfdx-nimbleams)
[![Downloads/week](https://img.shields.io/npm/dw/@nimbleams/sfdx-nimbleams.svg)](https://npmjs.org/package/@nimbleams/sfdx-nimbleams)

<!-- toc -->
* [Clone repo](#clone-repo)
* [Change directory](#change-directory)
* [Install npm dependencies](#install-npm-dependencies)
* [Link plugin](#link-plugin)
* [Debugging your plugin](#debugging-your-plugin)
<!-- tocstop -->
<!-- install -->
<!-- usage -->
```sh-session
$ npm install -g @nimbleams/sfdx-nimbleams
$ sfdx COMMAND
running command...
$ sfdx (--version)
@nimbleams/sfdx-nimbleams/1.16.0 linux-x64 node-v22.18.0
$ sfdx --help [COMMAND]
USAGE
  $ sfdx COMMAND
...
```
<!-- usagestop -->
<!-- commands -->
* [`sfdx nimbleams:cci:org:rename -p <string> -o <string> -a <string> [-y] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-nimbleamscciorgrename--p-string--o-string--a-string--y---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [`sfdx nimbleams:cci:org:stash -p <string> -o <string> [-a <string>] [-y] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-nimbleamscciorgstash--p-string--o-string--a-string--y---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [`sfdx nimbleams:cci:org:unstash -p <string> -o <string> [-a <string>] [-y] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-nimbleamscciorgunstash--p-string--o-string--a-string--y---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [`sfdx nimbleams:cci:stash:list [-p <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-nimbleamsccistashlist--p-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [`sfdx nimbleams:community:publish -n <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-nimbleamscommunitypublish--n-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [`sfdx nimbleams:communityhub:config:import -f <string> [-n <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-nimbleamscommunityhubconfigimport--f-string--n-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [`sfdx nimbleams:data:export -f <string> -d <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-nimbleamsdataexport--f-string--d-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [`sfdx nimbleams:data:import -f <string> [-y <string>] [-b] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-nimbleamsdataimport--f-string--y-string--b--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [`sfdx nimbleams:org:connectedapp:create -n <string> [-l <string>] [-d <string>] [-e <string>] [-c <string>] [-o <string>] [-k <string>] [-s <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-nimbleamsorgconnectedappcreate--n-string--l-string--d-string--e-string--c-string--o-string--k-string--s-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [`sfdx nimbleams:org:dependencies:install [-s <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-nimbleamsorgdependenciesinstall--s-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [`sfdx nimbleams:org:dependencies:register -p <string> -k <string> [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-nimbleamsorgdependenciesregister--p-string--k-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [`sfdx nimbleams:org:package:install -p <string> [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-nimbleamsorgpackageinstall--p-string--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [`sfdx nimbleams:org:pool:fetch -t <string> [-p <string>] [-u <string>] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-nimbleamsorgpoolfetch--t-string--p-string--u-string--v-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [`sfdx nimbleams:org:pool:import -t <string> [-a <string>] [-s] [-p <string>] [-u <string>] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-nimbleamsorgpoolimport--t-string--a-string--s--p-string--u-string--v-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [`sfdx nimbleams:postman:environment:generate [-t <string>] [-c] [-f <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-nimbleamspostmanenvironmentgenerate--t-string--c--f-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [`sfdx nimbleams:profile:admin:update [-r <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-nimbleamsprofileadminupdate--r-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [`sfdx nimbleams:profile:reconcile -f <string> -n <array> [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-nimbleamsprofilereconcile--f-string--n-array---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [`sfdx nimbleams:project:add [-k <string>] [-g <string>] [-d <filepath>] [-i <filepath>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-nimbleamsprojectadd--k-string--g-string--d-filepath--i-filepath---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [`sfdx nimbleams:project:delete [-f] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-nimbleamsprojectdelete--f---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [`sfdx nimbleams:project:list [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-nimbleamsprojectlist---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [`sfdx nimbleams:project:namespace:replace -o <string> -p <string> [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-nimbleamsprojectnamespacereplace--o-string--p-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [`sfdx nimbleams:site:seturlrewriter -s <string> -c <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-nimbleamssiteseturlrewriter--s-string--c-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [`sfdx nimbleams:task:start -p <string> [-t <filepath>] [-b <string>] [-o] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-nimbleamstaskstart--p-string--t-filepath--b-string--o--v-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [`sfdx nimbleams:workspace:configure [-c] [-o <string>] [--currencies <string>] [--avataxuser <string>] [--avataxpassword <string>] [--features <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-nimbleamsworkspaceconfigure--c--o-string---currencies-string---avataxuser-string---avataxpassword-string---features-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [`sfdx nimbleams:workspace:setup [-s] [-o <string>] [-p <string>] [-t <string>] [-e <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-nimbleamsworkspacesetup--s--o-string--p-string--t-string--e-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)

## `sfdx nimbleams:cci:org:rename -p <string> -o <string> -a <string> [-y] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

Renames an org configuration for a CumulusCI project.

```
USAGE
  $ sfdx nimbleams:cci:org:rename -p <string> -o <string> -a <string> [-y] [--json] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -a, --alias=<value>                                                               (required) The new org configuration
                                                                                    name.
  -o, --org=<value>                                                                 (required) The name of the org
                                                                                    configuration to rename.
  -p, --project=<value>                                                             (required) The name of the project.
  -y, --noprompt                                                                    Do not prompt for stash org
                                                                                    overwrite confirmation.
  --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
  Renames an org configuration for a CumulusCI project.

EXAMPLES
  $ sfdx nimbleams:org:cci:rename -p nams-headless-org -o dev_namespaced -a dev_namespaced_old
```

## `sfdx nimbleams:cci:org:stash -p <string> -o <string> [-a <string>] [-y] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

Stashes an org configuration for a CumulusCI project.

```
USAGE
  $ sfdx nimbleams:cci:org:stash -p <string> -o <string> [-a <string>] [-y] [--json] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -a, --alias=<value>                                                               Alias to use when stashing the org.
                                                                                    Use this alias when unstashing.
  -o, --org=<value>                                                                 (required) The name of the org
                                                                                    configuration to stash.
  -p, --project=<value>                                                             (required) The name of the project.
  -y, --noprompt                                                                    Do not prompt for stash org
                                                                                    overwrite confirmation.
  --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
  Stashes an org configuration for a CumulusCI project.

EXAMPLES
  $ sfdx nimbleams:org:cci:stash -p nams-headless-org -o dev_namespaced

  $ sfdx nimbleams:org:cci:stash -p nams-headless-org -o dev_namespaced -a dev_namespaced_123
```

## `sfdx nimbleams:cci:org:unstash -p <string> -o <string> [-a <string>] [-y] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

Unstashes an org configuration for a CumulusCI project.

```
USAGE
  $ sfdx nimbleams:cci:org:unstash -p <string> -o <string> [-a <string>] [-y] [--json] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -a, --alias=<value>                                                               Provide this when you are unstashing
                                                                                    an org with an alias.
  -o, --org=<value>                                                                 (required) The name of the org
                                                                                    configuration to unstash.
  -p, --project=<value>                                                             (required) The name of the project.
  -y, --noprompt                                                                    Do not prompt for unstash org
                                                                                    overwrite confirmation.
  --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
  Unstashes an org configuration for a CumulusCI project.

EXAMPLES
  $ sfdx nimbleams:org:cci:unstash -p nams-headless-org -o dev_namespaced

  $ sfdx nimbleams:org:cci:unstash -p nams-headless-org -o dev_namespaced -a dev_namespaced_123
```

## `sfdx nimbleams:cci:stash:list [-p <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

Lists stashed CumulusCI org configurations.

```
USAGE
  $ sfdx nimbleams:cci:stash:list [-p <string>] [--json] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -p, --project=<value>                                                             The name of the project to get the
                                                                                    stashed orgs for.
  --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
  Lists stashed CumulusCI org configurations.

EXAMPLES
  $ sfdx nimbleams:org:cci:stash:list

  $ sfdx nimbleams:org:cci:stash:list -p nams-headless-org
```

## `sfdx nimbleams:community:publish -n <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

Publishes an Experience Cloud site.

```
USAGE
  $ sfdx nimbleams:community:publish -n <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -n, --name=<value>                                                                (required) The name of the
                                                                                    Experience Cloud site to publish.
  -u, --targetusername=<value>                                                      username or alias for the target
                                                                                    org; overrides default target 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
  Publishes an Experience Cloud site.

EXAMPLES
  $ sfdx nimbleams:community:publish -n MyCommunity
```

## `sfdx nimbleams:communityhub:config:import -f <string> [-n <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

Import Community Hub configuration.

```
USAGE
  $ sfdx nimbleams:communityhub:config:import -f <string> [-n <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -f, --file=<value>                                                                (required) The JSON configuration
                                                                                    file to import.
  -n, --namespace=<value>                                                           [default: NC] The namespace of
                                                                                    Community Hub.
  -u, --targetusername=<value>                                                      username or alias for the target
                                                                                    org; overrides default target 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
  Import Community Hub configuration.

EXAMPLES
  $ sfdx nimbleams:communityhub:config:import -f config.json

  $ sfdx nimbleams:communityhub:config:import -f config.json -n znc2
```

## `sfdx nimbleams:data:export -f <string> -d <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

export data using nimbleforce

```
USAGE
  $ sfdx nimbleams:data:export -f <string> -d <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -d, --destination=<value>                                                         (required) path to the directory
                                                                                    where you want exported data to be
                                                                                    saved.
  -f, --file=<value>                                                                (required) the path to a json file
                                                                                    with query objects for the export
  -u, --targetusername=<value>                                                      username or alias for the target
                                                                                    org; overrides default target 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
  export data using nimbleforce
```

## `sfdx nimbleams:data:import -f <string> [-y <string>] [-b] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

import data using nimbleforce

```
USAGE
  $ sfdx nimbleams:data:import -f <string> [-y <string>] [-b] [-u <string>] [--apiversion <string>] [--json] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -b, --bulk                                                                        use the bulk API for data import
  -f, --file=<value>                                                                (required) the path to the manifest
                                                                                    file for the data to import
  -u, --targetusername=<value>                                                      username or alias for the target
                                                                                    org; overrides default target org
  -y, --yearoffsetfrom=<value>                                                      the year from which to offset dates
  --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
  import data using nimbleforce

EXAMPLES
  $ sfdx nimbleams:data:import --targetusername myOrg@example.com --file data/insertOrder.json
```

## `sfdx nimbleams:org:connectedapp:create -n <string> [-l <string>] [-d <string>] [-e <string>] [-c <string>] [-o <string>] [-k <string>] [-s <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

Creates a connected app in the target org.

```
USAGE
  $ sfdx nimbleams:org:connectedapp:create -n <string> [-l <string>] [-d <string>] [-e <string>] [-c <string>] [-o <string>] [-k
    <string>] [-s <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -c, --oauthcallbackurl=<value>                                                    Callback URL for OAuth.
  -d, --description=<value>                                                         Description for the connected app.
  -e, --contactemail=<value>                                                        Contact email for the connected app.
  -k, --oauthkey=<value>                                                            Consumer Key for OAuth.
  -l, --label=<value>                                                               The label for the connected app.
  -n, --name=<value>                                                                (required) The name for the
                                                                                    connected app.
  -o, --oauthscopes=<value>                                                         Scopes for OAuth.
  -s, --oauthsecret=<value>                                                         Consumer Secret for OAuth.
  -u, --targetusername=<value>                                                      username or alias for the target
                                                                                    org; overrides default target 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
  Creates a connected app in the target org.

EXAMPLES
  $ sfdx nimbleams:org:connectedapp:create -n 'IntegrationTest' --targetusername myOrg@example.com
```

## `sfdx nimbleams:org:dependencies:install [-s <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

Install all project dependencies

```
USAGE
  $ sfdx nimbleams:org:dependencies:install [-s <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -s, --securitytype=<value>                                                        Security access type for the
                                                                                    installed package. Permissible
                                                                                    values are: AllUsers, AdminsOnly.
  -u, --targetusername=<value>                                                      username or alias for the target
                                                                                    org; overrides default target 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
  Install all project dependencies

EXAMPLES
  $ sfdx nimbleams:org:dependencies:install --targetusername myOrg@example.com

  $ sfdx nimbleams:org:dependencies:install -s AllUsers --targetusername myOrg@example.com
```

## `sfdx nimbleams:org:dependencies:register -p <string> -k <string> [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

Locally registers the credentials (key) of a password protected managed package.

```
USAGE
  $ sfdx nimbleams:org:dependencies:register -p <string> -k <string> [--json] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -k, --key=<value>                                                                 (required) The key (password) of the
                                                                                    package.
  -p, --package=<value>                                                             (required) The Id (04t) or alias as
                                                                                    defined in the sfdx-project.json
                                                                                    file of the package to register.
  --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
  Locally registers the credentials (key) of a password protected managed package.

EXAMPLES
  $ sfdx nimbleams:org:dependencies:register --package 04t1H0000004AcSQAU --key Honor1000
```

## `sfdx nimbleams:org:package:install -p <string> [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

Installs all packages specified.

```
USAGE
  $ sfdx nimbleams:org:package:install -p <string> [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -p, --packages=<value>                                                            (required) The ID (starts with 04t)
                                                                                    of the package version to install.
                                                                                    If an installation key is needed,
                                                                                    separate with a colon
                                                                                    (04t...:installationkey).
  -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
  --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
  Installs all packages specified.

EXAMPLES
  $ sfdx nimbleams:org:package:install -p 04t... --targetusername myOrg@example.com

  $ sfdx nimbleams:org:package:install --packages "04t...:installationkey" -u myOrg@example.com

  $ sfdx nimbleams:org:package:install --packages "04t...:installationkey,04t...,04t..." --targetusername myOrg@example.com
```

## `sfdx nimbleams:org:pool:fetch -t <string> [-p <string>] [-u <string>] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

Fetches an org from a pool.

```
USAGE
  $ sfdx nimbleams:org:pool:fetch -t <string> [-p <string>] [-u <string>] [-v <string>] [--apiversion <string>] [--json]
    [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -p, --purpose=<value>                                                             The purpose for which the org is
                                                                                    being used.
  -t, --pooltag=<value>                                                             (required) The pool tag to fetch.
  -u, --username=<value>                                                            The username of the user for which
                                                                                    the org is being provisioned.
  -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
  Fetches an org from a pool.

EXAMPLES
  $ sfdx nimbleams:org:pool:fetch -t znu
```

## `sfdx nimbleams:org:pool:import -t <string> [-a <string>] [-s] [-p <string>] [-u <string>] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

Imports an org from a pool using the OAuth web flow.

```
USAGE
  $ sfdx nimbleams:org:pool:import -t <string> [-a <string>] [-s] [-p <string>] [-u <string>] [-v <string>] [--apiversion
    <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -a, --setalias=<value>                                                            Alias to set for the imported org.
  -p, --purpose=<value>                                                             The purpose for which the org is
                                                                                    being used.
  -s, --setdefaultusername                                                          Option to set the imported org as
                                                                                    the default.
  -t, --pooltag=<value>                                                             (required) The pool tag to fetch and
                                                                                    import.
  -u, --username=<value>                                                            The username of the user for which
                                                                                    the org is being provisioned.
  -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
  Imports an org from a pool using the OAuth web flow.

EXAMPLES
  $ sfdx nimbleams:org:pool:import -t znu

  $ sfdx nimbleams:org:pool:import -t nams-znu -a nu-nams-orders-org__dev_namespaced
```

## `sfdx nimbleams:postman:environment:generate [-t <string>] [-c] [-f <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

Generates a Postman environment for the specified username.

```
USAGE
  $ sfdx nimbleams:postman:environment:generate [-t <string>] [-c] [-f <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -c, --copytoclipboard                                                             Copies the environment JSON to your
                                                                                    clipboard.
  -f, --filepath=<value>                                                            File path to write the environment
                                                                                    JSON to (eg. ScratchOrg.postman_envi
                                                                                    ronment.json).
  -t, --testusername=<value>                                                        User to run tests as. The target
                                                                                    user / default user will be used to
                                                                                    create the Connected App.
  -u, --targetusername=<value>                                                      username or alias for the target
                                                                                    org; overrides default target 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
  Generates a Postman environment for the specified username.

EXAMPLES
  $ sfdx nimbleams:postman:environment:generate --targetusername myOrg@example.com

  $ sfdx nimbleams:postman:environment:generate -t qa-user@example.com --targetusername myOrg@example.com

  $ sfdx nimbleams:postman:environment:generate -t qa-user@example.com -f org.json --targetusername myOrg@example.com
```

## `sfdx nimbleams:profile:admin:update [-r <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

Grants the admin profile full FLS and tab permissions.

```
USAGE
  $ sfdx nimbleams:profile:admin:update [-r <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -r, --recordtypes=<value>                                                         Optionally sets record type
                                                                                    visibility and defaults.
  -u, --targetusername=<value>                                                      username or alias for the target
                                                                                    org; overrides default target 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
  Grants the admin profile full FLS and tab permissions.

EXAMPLES
  $ sfdx nimbleams:profile:admin:update

  $ sfdx nimbleams:profile:admin:update -r '[{"recordType":"Account.Business_Account","default":true}]'
```

## `sfdx nimbleams:profile:reconcile -f <string> -n <array> [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

reconcile profile metadata

```
USAGE
  $ sfdx nimbleams:profile:reconcile -f <string> -n <array> [--json] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -f, --folder=<value>                                                              (required) path to the folder which
                                                                                    contains the profiles to be
                                                                                    reconciled
  -n, --profilelist=<value>                                                         (required) list of profiles to be
                                                                                    reconciled
  --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
  reconcile profile metadata

EXAMPLES
  $ sfdx nimbleams:profile:reconcile -f sfdx-source -n Admin
```

## `sfdx nimbleams:project:add [-k <string>] [-g <string>] [-d <filepath>] [-i <filepath>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

add a new project

```
USAGE
  $ sfdx nimbleams:project:add [-k <string>] [-g <string>] [-d <filepath>] [-i <filepath>] [--json] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -d, --definitionfile=<value>                                                      scratch org configuration file
  -g, --gitremote=<value>                                                           git remote containing an sfdx
                                                                                    project
  -i, --nimbleforceimportfile=<value>                                               nimbleforce import file
  -k, --key=<value>                                                                 project key
  --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
  add a new project

EXAMPLES
  $ sfdx nimbleams:project:add
```

## `sfdx nimbleams:project:delete [-f] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

delete a project

```
USAGE
  $ sfdx nimbleams:project:delete [-f] [--json] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

ARGUMENTS
  KEY  project key to delete

FLAGS
  -f, --force                                                                       skips any prompts and forces delete
  --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
  delete a project

EXAMPLES
  $ sfdx nimbleams:project:delete AMS
```

## `sfdx nimbleams:project:list [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

lists all configured projects

```
USAGE
  $ sfdx nimbleams:project:list [--json] [--loglevel
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  --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
  lists all configured projects

EXAMPLES
  $ sfdx nimbleams:project:list
```

## `sfdx nimbleams:project:namespace:replace -o <string> -p <string> [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

Changes namespace prefixes in the current project.

```
USAGE
  $ sfdx nimbleams:project:namespace:replace -o <string> -p <string> [--json] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -o, --oldprefix=<value>                                                           (required) The namespace prefix to
                                                                                    replace.
  -p, --prefix=<value>                                                              (required) The new namespace prefix.
  --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
  Changes namespace prefixes in the current project.

EXAMPLES
  $ sfdx nimbleams:project:namespace -o znu -p NU
```

## `sfdx nimbleams:site:seturlrewriter -s <string> -c <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

Set the Url Rewriter of a Site.

```
USAGE
  $ sfdx nimbleams:site:seturlrewriter -s <string> -c <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -c, --class=<value>                                                               (required) The name of the Apex
                                                                                    Class.
  -s, --site=<value>                                                                (required) The name of the Site
                                                                                    record.
  -u, --targetusername=<value>                                                      username or alias for the target
                                                                                    org; overrides default target 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
  Set the Url Rewriter of a Site.

EXAMPLES
  $ sfdx nimbleams:site:seturlrewriter -s Community_Hub -c UrlRewriter2
```

## `sfdx nimbleams:task:start -p <string> [-t <filepath>] [-b <string>] [-o] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

start a nimbleams task

```
USAGE
  $ sfdx nimbleams:task:start -p <string> [-t <filepath>] [-b <string>] [-o] [-v <string>] [--apiversion <string>]
    [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

ARGUMENTS
  TASK  the task name to start (used for branch name, folder name, and scratch org alias)

FLAGS
  -b, --branch=<value>                                                              existing branch to start from
  -o, --open                                                                        open vs code after command is
                                                                                    complete
  -p, --project=<value>                                                             (required) project key to use for
                                                                                    starting task
  -t, --targetdirectory=<value>                                                     target directory to create project
                                                                                    folder in
  -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
  start a nimbleams task

EXAMPLES
  $ sfdx nimbleams:task:start AMS-1234 -p AMS

  $ sfdx nimbleams:task:start AMS-1234 -p AMS -t ~/Projects/nu-dx/ -o
```

## `sfdx nimbleams:workspace:configure [-c] [-o <string>] [--currencies <string>] [--avataxuser <string>] [--avataxpassword <string>] [--features <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

Configure additional metadata features on a target org (Enterprise Pricing, Multi-Currency, Avatax).

```
USAGE
  $ sfdx nimbleams:workspace:configure [-c] [-o <string>] [--currencies <string>] [--avataxuser <string>] [--avataxpassword
    <string>] [--features <string>] [--json] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -c, --customized
      Run in interactive mode, prompting for all configuration values instead of using defaults.

  -o, --org=<value>
      The target org alias or username to configure. Falls back to the sf CLI default target-org if not provided.

  --avataxpassword=<value>
      Avatax REST API password.

  --avataxuser=<value>
      Avatax REST API username.

  --currencies=<value>
      [default: USD, EUR, DOP] Comma-separated currency codes to add when Multi-Currency is enabled (e.g. 'USD, EUR,
      DOP'). Only applies if 'Multi-Currency' is included in --features.

  --features=<value>
      [default: Multi-Currency,Enterprise Pricing] Comma-separated additional features to enable (e.g.
      'Multi-Currency,Enterprise Pricing'). Avatax is controlled via the packages config.

  --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
  Configure additional metadata features on a target org (Enterprise Pricing, Multi-Currency, Avatax).

EXAMPLES
  $ sfdx nimbleams:workspace:configure --org myOrg

  $ sfdx nimbleams:workspace:configure --org myOrg --customized
```

## `sfdx nimbleams:workspace:setup [-s] [-o <string>] [-p <string>] [-t <string>] [-e <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

Set up a NAMS Workspace project.

```
USAGE
  $ sfdx nimbleams:workspace:setup [-s] [-o <string>] [-p <string>] [-t <string>] [-e <string>] [--json] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -e, --epicbranch=<value>                                                          (Optional) The epic branch to check
                                                                                    out.
  -o, --org=<value>                                                                 (Optional) CumulusCI org reference
                                                                                    (usually dev_namespaced).
  -p, --project=<value>                                                             (Optional) Project name (or 'All')
                                                                                    to pull down and skip the prompt.
  -s, --skiphooks                                                                   Whether running the configured hooks
                                                                                    should be skipped or not.
  -t, --taskbranch=<value>                                                          (Optional) The task branch to check
                                                                                    out.
  --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
  Set up a NAMS Workspace project.

EXAMPLES
  $ sfdx nimbleams:workspace:setup

  $ sfdx nimbleams:workspace:setup -r false
```
<!-- commandsstop -->
<!-- debugging-your-plugin -->
# Debugging your plugin
We recommend using the Visual Studio Code (VS Code) IDE for your plugin development. Included in the `.vscode` directory of this plugin is a `launch.json` config file, which allows you to attach a debugger to the node process when running your commands.

To debug the `hello:org` command:
1. Start the inspector

If you linked your plugin to the sfdx cli, call your command with the `dev-suspend` switch:
```sh-session
$ sfdx hello:org -u myOrg@example.com --dev-suspend
```

Alternatively, to call your command using the `bin/run` script, set the `NODE_OPTIONS` environment variable to `--inspect-brk` when starting the debugger:
```sh-session
$ NODE_OPTIONS=--inspect-brk bin/run hello:org -u myOrg@example.com
```

2. Set some breakpoints in your command code
3. Click on the Debug icon in the Activity Bar on the side of VS Code to open up the Debug view.
4. In the upper left hand corner of VS Code, verify that the "Attach to Remote" launch configuration has been chosen.
5. Hit the green play button to the left of the "Attach to Remote" launch configuration window. The debugger should now be suspended on the first line of the program.
6. Hit the green play button at the top middle of VS Code (this play button will be to the right of the play button that you clicked in step #5).
<br><img src=".images/vscodeScreenshot.png" width="480" height="278"><br>
Congrats, you are debugging!