# @rpidanny/unquill-cli

> Unquill CLI is a component of the Unquill project, designed to enhance the Developer Experience (DX) by simplifying the parsing of JSON logs generated by services using the [Quill](https://github.com/rpidanny/quill) logging library. It transforms complex

Latest version **1.0.3** (published 2023-11-02) · 0 weekly downloads

## Install

```sh
npm install @rpidanny/unquill-cli
pnpm add @rpidanny/unquill-cli
yarn add @rpidanny/unquill-cli
bun add @rpidanny/unquill-cli
```

Provides the command `unquill`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2023-11-02 |
| First published | 2023-10-30 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 351 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Maintainers | mabhishek |
| Keywords | quill, unquill, logging, dx, local-development |

## Links

- npm: https://www.npmjs.com/package/@rpidanny/unquill-cli
- Repository: https://github.com/rpidanny/unquill
- Homepage: https://github.com/rpidanny/unquill#readme
- Issues: https://github.com/rpidanny/unquill/issues
- npm.io page: https://npm.io/package/@rpidanny/unquill-cli

## Dependencies (3)

- [chalk](https://npm.io/package/chalk.md) ^4.1.2
- [commander](https://npm.io/package/commander.md) ^11.1.0
- [@rpidanny/unquill-core](https://npm.io/package/@rpidanny/unquill-core.md) *

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 1.0.3 (latest) — 2023-11-02
- 1.0.2 — 2023-10-30
- 1.0.1 — 2023-10-30
- 1.0.0 — 2023-10-30

## README

# Unquill CLI - Log Parsing Made Easy

Unquill CLI is a component of the Unquill project, designed to enhance the Developer Experience (DX) by simplifying the parsing of JSON logs generated by services using the [Quill](https://github.com/rpidanny/quill) logging library. It transforms complex JSON logs into human-readable format, making local debugging a breeze.

## Installation

Install Unquill CLI globally using npm:

```bash
npm install -g @rpidanny/unquill-cli
```

## Usage

`Unquill` is simple to use, and it seamlessly integrates with your existing development environment. Simply invoke it from the command line followed by the command you want to run.

Here's the basic syntax:

```bash
unquill [options] -- [command]
```

### Options

- `-s` (or `--service`): Include the service name in the log output.
- `--jq`: Apply a raw [jq](https://jqlang.github.io/jq/tutorial/) filter to include additional fields in the log.

### Examples Usage

#### Basic Usage

```bash
unquill -- node app.js
```

This command will run `app.js` and display the Quill logs in a user-friendly format without the service name.

#### Include Service Name

```bash
unquill -s -- node app.js
```

Including the `-s` flag will add the service name to the log entries, making it easier to distinguish logs from different services.

#### Include Custom Fields

```bash
unquill --jq ".details.userId" -- node app.js
```

Using the `--jq` option with a [jq](https://jqlang.github.io/jq/tutorial/) filter, you can selectively include specific fields in the log output.

## Contributing

If you would like to contribute to `Unquill`, please check out the [GitHub repository](https://github.com/rpidanny/unquill) and feel free to submit issues, pull requests, or provide feedback.

---
_Source: https://npm.io/package/@rpidanny/unquill-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._