npm package: @pmalicki/sforce-summit-plugin
Description: SF CLI Plug-In demo
Author: Piotr Malicki
Latest version: 0.0.1

@pmalicki/sforce-summit-plugin
==============================

SF CLI Plug-In demo

[![Version](https://img.shields.io/npm/v/@pmalicki/sforce-summit-plugin.svg)](https://npmjs.org/package/@pmalicki/sforce-summit-plugin)
[![CircleCI](https://circleci.com/gh/piotr-malicki/sforce-summit-plugin/tree/master.svg?style=shield)](https://circleci.com/gh/piotr-malicki/sforce-summit-plugin/tree/master)
[![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/piotr-malicki/sforce-summit-plugin?branch=master&svg=true)](https://ci.appveyor.com/project/heroku/sforce-summit-plugin/branch/master)
[![Greenkeeper](https://badges.greenkeeper.io/piotr-malicki/sforce-summit-plugin.svg)](https://greenkeeper.io/)
[![Known Vulnerabilities](https://snyk.io/test/github/piotr-malicki/sforce-summit-plugin/badge.svg)](https://snyk.io/test/github/piotr-malicki/sforce-summit-plugin)
[![Downloads/week](https://img.shields.io/npm/dw/@pmalicki/sforce-summit-plugin.svg)](https://npmjs.org/package/@pmalicki/sforce-summit-plugin)
[![License](https://img.shields.io/npm/l/@pmalicki/sforce-summit-plugin.svg)](https://github.com/piotr-malicki/sforce-summit-plugin/blob/master/package.json)

<!-- toc -->
* [Debugging your plugin](#debugging-your-plugin)
<!-- tocstop -->
<!-- install -->
<!-- usage -->
```sh-session
$ npm install -g @pmalicki/sforce-summit-plugin
$ sfdx COMMAND
running command...
$ sfdx (--version)
@pmalicki/sforce-summit-plugin/0.0.1 darwin-arm64 node-v18.0.0
$ sfdx --help [COMMAND]
USAGE
  $ sfdx COMMAND
...
```
<!-- usagestop -->
<!-- commands -->
* [`sfdx hello:org [-n <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-helloorg--n-string--f--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [`sfdx sforce:org:setup -c <directory> -m <directory> [-a <string>] [-d] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-sforceorgsetup--c-directory--m-directory--a-string--d--v-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)

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

print a greeting and your org IDs

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

FLAGS
  -f, --force                                                                       example boolean flag
  -n, --name=<value>                                                                name to print
  -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
  print a greeting and your org IDs

EXAMPLES
  $ sfdx hello:org --targetusername myOrg@example.com --targetdevhubusername devhub@org.com

  $ sfdx hello:org --name myname --targetusername myOrg@example.com
```

_See code: [src/commands/hello/org.ts](https://github.com/piotr-malicki/sforce-summit-plugin/blob/v0.0.1/src/commands/hello/org.ts)_

## `sfdx sforce:org:setup -c <directory> -m <directory> [-a <string>] [-d] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

set up new org

```
USAGE
  $ sfdx sforce:org:setup -c <directory> -m <directory> [-a <string>] [-d] [-v <string>] [--apiversion <string>]
    [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -a, --alias=<value>                                                               scratch org alias
  -c, --configfile=<value>                                                          (required) [default:
                                                                                    config/project-scratch-def.json]
                                                                                    path to scratch org configuration
  -d, --defautl                                                                     set an org as default
  -m, --metadata=<value>                                                            (required) [default: force-app]
                                                                                    metadata directory
  -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
  set up new org

EXAMPLES
  $ sfdx sforce:org:setup

  $ sfdx sforce:org:setup -a my-new-org -m force-app -c config/project-scratch-def.json -v DevHub
```

_See code: [src/commands/sforce/org/setup.ts](https://github.com/piotr-malicki/sforce-summit-plugin/blob/v0.0.1/src/commands/sforce/org/setup.ts)_
<!-- 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!