{"id":13731686,"url":"https://github.com/mdp/qrterminal","last_synced_at":"2025-05-14T14:08:27.037Z","repository":{"id":39706866,"uuid":"49629480","full_name":"mdp/qrterminal","owner":"mdp","description":"QR Codes in your terminal","archived":false,"fork":false,"pushed_at":"2025-03-19T17:51:30.000Z","size":69,"stargazers_count":464,"open_issues_count":1,"forks_count":55,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-08T06:33:20.617Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mdp.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-01-14T07:10:29.000Z","updated_at":"2025-03-27T02:14:20.000Z","dependencies_parsed_at":"2022-08-24T01:30:56.812Z","dependency_job_id":"22739627-36ae-4f3a-b081-8e63238284db","html_url":"https://github.com/mdp/qrterminal","commit_stats":{"total_commits":50,"total_committers":11,"mean_commits":4.545454545454546,"dds":0.28,"last_synced_commit":"2d47ea1fb6316725f76c19fcf29c985e46cd8e94"},"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mdp%2Fqrterminal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mdp%2Fqrterminal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mdp%2Fqrterminal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mdp%2Fqrterminal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mdp","download_url":"https://codeload.github.com/mdp/qrterminal/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254159780,"owners_count":22024564,"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":[],"created_at":"2024-08-03T02:01:35.883Z","updated_at":"2025-05-14T14:08:27.013Z","avatar_url":"https://github.com/mdp.png","language":"Go","funding_links":[],"categories":["Misc","Go"],"sub_categories":[],"readme":"# QRCode Terminal\n\n[![Build Status](https://github.com/mdp/qrterminal/actions/workflows/build.yml/badge.svg)](https://github.com/mdp/qrterminal/actions/workflows/build.yml)\n\nA golang library for generating QR codes in the terminal.\n\nOriginally this was a port of the [NodeJS version](https://github.com/gtanner/qrcode-terminal). Recently it's been updated to allow for smaller code generation using ASCII 'half blocks'\n\n## Example\nFull size ASCII block QR Code:  \n\u003cimg src=\"https://user-images.githubusercontent.com/2868/37992336-0ba06b56-31d1-11e8-9d32-5c6bb008dc74.png\" alt=\"alt text\" width=\"225\" height=\"225\"\u003e\n\nSmaller 'half blocks' in the terminal:  \n\u003cimg src=\"https://user-images.githubusercontent.com/2868/37992371-243d4238-31d1-11e8-92f8-e34a794b21af.png\" alt=\"alt text\" width=\"225\" height=\"225\"\u003e\n\n## Install\n\nFor command line usage [see below](https://github.com/mdp/qrterminal#command-line), or grab the binary from the [releases page](https://github.com/mdp/qrterminal/releases)\n\nAs a library in an application\n\n`go get github.com/mdp/qrterminal/v3`\n\n## Usage\n\n```go\nimport (\n    \"github.com/mdp/qrterminal/v3\"\n    \"os\"\n    )\n\nfunc main() {\n  // Generate a 'dense' qrcode with the 'Low' level error correction and write it to Stdout\n  qrterminal.Generate(\"https://github.com/mdp/qrterminal\", qrterminal.L, os.Stdout)\n}\n```\n\n### More complicated\n\nLarge Inverted barcode with medium redundancy and a 1 pixel border\n```go\nimport (\n    \"github.com/mdp/qrterminal/v3\"\n    \"os\"\n    )\n\nfunc main() {\n  config := qrterminal.Config{\n      Level: qrterminal.M,\n      Writer: os.Stdout,\n      BlackChar: qrterminal.WHITE,\n      WhiteChar: qrterminal.BLACK,\n      QuietZone: 1,\n  }\n  qrterminal.GenerateWithConfig(\"https://github.com/mdp/qrterminal\", config)\n}\n```\n\nHalfBlock barcode with medium redundancy\n```go\nimport (\n    \"github.com/mdp/qrterminal/v3\"\n    \"os\"\n    )\n\nfunc main() {\n  config := qrterminal.Config{\n      HalfBlocks: true,\n      Level: qrterminal.M,\n      Writer: os.Stdout,\n  }\n  qrterminal.GenerateWithConfig(\"https://github.com/mdp/qrterminal\", config)\n}\n```\n\n\n## Command Line\n\n#### Installation\n\nOSX: `brew install mdp/tap/qrterminal`\n\nOthers: Download from the [releases page](https://github.com/mdp/qrterminal/releases)\n\nSource: `go install github.com/mdp/qrterminal/v3/cmd/qrterminal@latest`\n\nDocker: `docker pull ghcr.io/mdp/qrterminal:latest`\n\n#### Usage\n\nPrint out a basic QR code in your terminal:  \n`qrterminal https://github.com/mdp/qrterminal`\n\nUsing 'medium' error correction:  \n`qrterminal https://github.com/mdp/qrterminal -l M`\n\nOr just use Docker: `docker run --rm ghcr.io/mdp/qrterminal:latest 'https://github.com/mdp/qrterminal'`\n\nYou can also pipe text via stdin\n\n`cat wireguard_peer.conf | qrterminal`\n\nor\n\n`cat wireguard_peer.conf | docker run --rm -i ghcr.io/mdp/qrterminal:latest`\n\n\n### Contributors/Credits:\n\n- [Mark Percival](https://github.com/mdp)\n- [Matthew Kennerly](https://github.com/mtkennerly)  \n- [Viric](https://github.com/viric)  \n- [WindomZ](https://github.com/WindomZ)  \n- [mattn](https://github.com/mattn)  \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmdp%2Fqrterminal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmdp%2Fqrterminal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmdp%2Fqrterminal/lists"}