{"id":16277945,"url":"https://github.com/rpidanny/unquill","last_synced_at":"2026-01-20T18:56:35.688Z","repository":{"id":204402197,"uuid":"708279163","full_name":"rpidanny/unquill","owner":"rpidanny","description":"Transform JSON logs generated by the Quill logging library into human-readable format for an enhanced Developer Experience (DX).","archived":false,"fork":false,"pushed_at":"2024-03-16T19:37:53.000Z","size":571,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-15T01:03:27.044Z","etag":null,"topics":["developer-experience","dx","local-development","logging","quill"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rpidanny.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-10-22T04:14:33.000Z","updated_at":"2023-11-02T19:07:40.000Z","dependencies_parsed_at":null,"dependency_job_id":"9d5e4765-c12c-4a1e-955c-73372c5db6af","html_url":"https://github.com/rpidanny/unquill","commit_stats":null,"previous_names":["rpidanny/unquill"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rpidanny%2Funquill","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rpidanny%2Funquill/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rpidanny%2Funquill/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rpidanny%2Funquill/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rpidanny","download_url":"https://codeload.github.com/rpidanny/unquill/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247730064,"owners_count":20986404,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["developer-experience","dx","local-development","logging","quill"],"created_at":"2024-10-10T18:56:49.625Z","updated_at":"2026-01-20T18:56:35.669Z","avatar_url":"https://github.com/rpidanny.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Unquill - Elegant Log Parsing for a Better DX\n\n`Unquill` is a lightweight, command-line tool designed to enhance your development experience (DX) when working with services that use the [Quill](https://github.com/rpidanny/quill) logging library.\n\n## Why Unquill?\n\nQuill produces structured JSON logs. While these logs are great for machine consumption, they can be challenging for engineers to read and understand in a local terminal. `Unquill` solves this problem by parsing and formatting Quill logs into a more human-readable format, making it easier to troubleshoot and debug services locally.\n\n## Installation\n\nYou can install `Unquill` globally using npm:\n\n```bash\nnpm i -g @rpidanny/unquill-cli\n```\n\n## Usage\n\nRun Unquill with your application using the following syntax:\n\n```bash\nunquill [options] -- node app.js\n```\n\n### Options\n\n- `-s`: Include the service name in the log.\n- `--jq \"\u003cjq-filter\u003e\"`: Apply a raw [jq](https://jqlang.github.io/jq/tutorial/) filter to include additional fields in the log.\n\n## Example Usage\n\n```bash\nunquill -s --jq \".details.userId\" -- node app.js\n```\n\n## Unquill Mono-Repository\n\nUnquill is organized as a mono-repository consisting of two main components:\n\n1. [unquill-cli](./packages/cli): The command-line interface (CLI) application.\n2. [unquill-core](./packages/core): The core log parsing component.\n\nFor detailed information on each component, refer to their respective READMEs.\n\n## Log Schema\n\n`Unquill` works with logs that adhere to the following [Quill](https://github.com/rpidanny/quill) log schema:\n\n```typescript\nexport interface FullLog {\n  level: string;\n  timestamp: number;\n  dateString: string;\n  stage?: string;\n  environment?: string;\n  hostname: string;\n  appName?: string;\n  componentName?: string;\n  region?: string;\n  service?: string;\n  message?: string;\n  details?: Record\u003cstring, unknown\u003e;\n  err?: {\n    name: string;\n    message: string;\n    stack?: string;\n  };\n  correlationId?: string;\n}\n```\n\n## Contributing\n\nIf 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.\n\n## License\n\n`Unquill` is open-source software licensed under the [MIT License](LICENSE).\n\n---\n\nHappy log parsing with `Unquill`! 🚀\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frpidanny%2Funquill","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frpidanny%2Funquill","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frpidanny%2Funquill/lists"}