open-index/open-npm huggingface dataset:
npm package: @inspektre/inspektre
Description: Inspektre cli
Author: Uday Korlimarla @udaykor
Latest version: 0.1.14

# Inspektre CLI & SDK 
Inspektre CLI and SDK is a command line tool and SDK for the Inspektre API.

## Wiki
`inspektre-cli` Wiki can be found [here](https://github.com/inspektre/inspektre/wiki)

## Purpose
This CLI utility is helpful in performing the following:
1. Query Inspektre Security Graphs.
2. Manage projects on Inspektre Platform.
3. Modify user roles or permissions.
4. Supress attack patterns or weaknesses or verifications.

`inspektre-cli` is a graphql client that queries to `api.inspektre.io` and query the `inspektre security graphs`. 


## Usage 
```
Usage: cli [options] [command]

  _                      _    _                           _ _
 (_)_ __  ___ _ __   ___| | _| |_ _ __ ___            ___| (_)
 | | '_ \/ __| '_ \ / _ \ |/ / __| '__/ _ \  _____   / __| | |
 | | | | \__ \ |_) |  __/   <| |_| | |  __/ |_____| | (__| | |
 |_|_| |_|___/ .__/ \___|_|\_\\__|_|  \___|          \___|_|_|
             |_|                                               

Options:
  -V, --version          output the version number
  -h, --help             display help for command

Commands:
  version               Display the version of Inspektre-CLI in use.
  auth [options]        Authenticate to Inspektre Platform.
  projects [options]    List/Create/Update projects on Inspektre Platform.
  playground            Manage temporary access the Inspektre  GraphQLPlayground.
```

## Authorize
Inspektre CLI command `authorize` is  *Device Authorization Grant* as specified in OAuth 2.0 RFC 8628 located [here](https://tools.ietf.org/html/rfc8628).
- To Authorize a device, run `inspektre-cli authorize`.
- For verbose mode, run `inspektre-cli authorize -v`.

## Reauthorize
Reauthroize command is used to refresh device authorization and extending the device authorization.
- To reauthorize, run `inspektre-cli reauthorize`.
- For Verbose, run `inspektre-cli reauthorize -v`.

## Environment Variables
- In order to use Inspektre `CLI`, Please ensure that an environment variable `CLIENT_ID` is set.
- You will be able find the `CLIENT_ID` under your account at `https://app.inspektre.io/app/account`.


##  Development
- When bumping cli `version`, Please change it in the package.json `manifest` file.
- This entry in the manifestis used to get the `version` into the CLI Client.

## Builds
In order to generate binaries for `Mac OS X` or`Windows` or `Linux`, Vercel `pkg` is required.

With Yarn
```
yarn global add pkg
```

With NPM
```
npm i -g pkg
```

## Typical Severity
- Critical, High, Medium, Low, Very Low

## Likelihood of Attack
- High, Low, Medium