open-index/open-npm huggingface dataset:
npm package: @quickloopio/cli
Description: ## Installation
Latest version: 1.1.3

# Quickloop CLI

## Installation

```shell
npm i -g @quickloopio/cli
```

## Source maps

### Uploading sourcemaps

```shell
qloop sourcemaps upload --apiKey <YOUR API KEY>
```

**Options:**

- `--dir <directory>` (shortcut `-d`) - Optional. Directory where the source map files are located. Default `./dist`
- `--remove` (shortcut `-rm`) - Optional. Instruct the CLI to remove the source maps after uploading them to quickloop.io. Recommended for production build.
npm package: @quickloopio/quickloop-sdk
Description: `QuickloopSdk` provides a set of in-browser functions to collect data for [quickloop.io](https://quickloop.io).
Latest version: 1.2.2

# Quickloop SDK Javascript Library

`QuickloopSdk` provides a set of in-browser functions to collect data for [quickloop.io](https://quickloop.io).

_**Important:** this library is NOT meant to be used on server-side._

## Installation

```shell
npm install @quickloop/quickloop-sdk
# OR
yarn add @quickloop/quickloop-sdk
```

## Quick start

### SDK Initialization

After signing up with [quickloop.io](https://quickloop.io), you should receive an API Key to use for the SDK. Use it to inialize the SDK as follow:

```javascript
import { QuickloopSdk } from '@quickloopio/quickloop-sdk';

const sdk = QuickloopSdk.init({
  apiKey: 'YOUR_API_KEY',
});
```

It will take the SDK a few seconds to be fully ready to track your network logs. You can check its status by calling `sdk.isReady()` function.

### Create a ticket

It is recommended to have a singleton SDK for your whole application. `QuickloopSdk` provides a static function `getInstance()` for you to retrieve the existing sdk instance.

```javascript
const sdk = QuickloopSdk.getInstance();

// To submit a ticket
await sdk.submitTicket(
  'My app does not load',
  {
    // You can also provide custom propertes for you ticket
    priority: 1,
  },
);
```

### Identify the reporter

Identifying the reporter helps you understand who creates the ticket, so you can plan out your follow-up action.  

```javascript
const sdk = QuickloopSdk.getInstance();
sdk.identify({
  /**
   * reporterId can be an email or any internal ID
   */
  reporterId: 'reporter@quickloop.io',

  /**
   * reporterGroupId helps you group the reporters.
   * This is helpful when your application is organization-based.
   */
  reporterGroupId: 'Quickloop Inc.',

  /**
   * You can also provide your own custom properties
   */
  customProperties: {
    firstName: 'John',
    lastName: 'Smith',
  },
})
```

### Hide elements from screen capture

Some sensitive information like passwords or credit card numbers should never be collected, even for debugging purpose. 

If you want to hide a specific HTML element from our screen capture, simply add the `quickloop__nocapture` class to it.

### Using built-in widgets

`QuickloopSdk` also provides some widgets out of the box, so you can start quickly without having to build your own forms. 

The widgets contain a floating button and form in the bottom right corner of the screen.

```javascript
const sdk = QuickloopSdk.getInstance();
sdk.loadWidgets();
```