npm package: @nreshef/foresight-sfdx-plugin
Description: foresight sfdx cli plugin
Author: nreshef
Latest version: 0.0.1

foresight-sfdx-plugin
=====================

foresight sfdx cli plugin

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

<!-- toc -->
* [Debugging your plugin](#debugging-your-plugin)
<!-- tocstop -->
<!-- install -->
<!-- usage -->
```sh-session
$ npm install -g @nreshef/foresight-sfdx-plugin
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
@nreshef/foresight-sfdx-plugin/0.0.1 win32-x64 node-v12.19.0
$ sfdx --help [COMMAND]
USAGE
  $ sfdx COMMAND
...
```
<!-- usagestop -->
<!-- commands -->
* [`sfdx foresight:analyze [-n <string>] [-r] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-foresightanalyze--n-string--r---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]`](#sfdx-helloorg--n-string--f--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)

## `sfdx foresight:analyze [-n <string>] [-r] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

print scope items from a file

```
print scope items from a file

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

OPTIONS
  -n, --name=name                                                                   name to print
  -r, --revision                                                                    fetch latest revision (commit) files
  --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

EXAMPLE
  $ sfdx hello:foresight --name myname
     Hello myname! Welcome to ForeSight
```

_See code: [lib/commands/foresight/analyze.js](https://github.com/git/foresight-sfdx-plugin/blob/v0.0.1/lib/commands/foresight/analyze.js)_

## `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

```
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]

OPTIONS
  -f, --force                                                                       example boolean flag
  -n, --name=name                                                                   name to print

  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  -v, --targetdevhubusername=targetdevhubusername                                   username or alias for the dev hub
                                                                                    org; overrides default dev hub org

  --apiversion=apiversion                                                           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

EXAMPLES
  $ sfdx hello:org --targetusername myOrg@example.com --targetdevhubusername devhub@org.com
     Hello world! This is org: MyOrg and I will be around until Tue Mar 20 2018!
     My hub org id is: 00Dxx000000001234
  
  $ sfdx hello:org --name myname --targetusername myOrg@example.com
     Hello myname! This is org: MyOrg and I will be around until Tue Mar 20 2018!
```

_See code: [lib/commands/hello/org.js](https://github.com/git/foresight-sfdx-plugin/blob/v0.0.1/lib/commands/hello/org.js)_
<!-- 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!