qrterminal

QR Codes in your terminal

  • Owner: mdp/qrterminal
  • Platform:
  • License:: MIT License
  • Category::
  • Topic:
  • Like:
    0
      Compare:

Github stars Tracking Chart

QRCode Terminal

Build Status

A golang library for generating QR codes in the terminal.

Originally this was a port of the NodeJS version. Recently it's been updated to allow for smaller code generation using ASCII 'half blocks'

Example

Full size ASCII block QR Code:

Smaller 'half blocks' in the terminal:

Install

For command line usage see below, or grab the binary from the releases page

As a library in an application

go get github.com/mdp/qrterminal/v3

Usage

import (
    "github.com/mdp/qrterminal/v3"
    "os"
    )

func main() {
  // Generate a 'dense' qrcode with the 'Low' level error correction and write it to Stdout
  qrterminal.Generate("https://github.com/mdp/qrterminal", qrterminal.L, os.Stdout)
}

More complicated

Large Inverted barcode with medium redundancy and a 1 pixel border

import (
    "github.com/mdp/qrterminal/v3"
    "os"
    )

func main() {
  config := qrterminal.Config{
      Level: qrterminal.M,
      Writer: os.Stdout,
      BlackChar: qrterminal.WHITE,
      WhiteChar: qrterminal.BLACK,
      QuietZone: 1,
  }
  qrterminal.GenerateWithConfig("https://github.com/mdp/qrterminal", config)
}

HalfBlock barcode with medium redundancy

import (
    "github.com/mdp/qrterminal/v3"
    "os"
    )

func main() {
  config := qrterminal.Config{
      HalfBlocks: true,
      Level: qrterminal.M,
      Writer: os.Stdout,
  }
  qrterminal.Generate("https://github.com/mdp/qrterminal", config)
}

Command Line

Installation

OSX: brew install mdp/tap/qrterminal

Others: Download from the releases page

Source: go get -u github.com/mdp/qrterminal/v3/cmd/qrterminal

Usage

Print out a basic QR code in your terminal:
qrterminal https://github.com/mdp/qrterminal

Using 'medium' error correction:
qrterminal https://github.com/mdp/qrterminal -l M

Or just use Docker: docker run --rm mpercival/qrterminal:latest 'https://github.com/mdp/qrterminal'

Contributors/Credits:

Main metrics

Overview
Name With Ownermdp/qrterminal
Primary LanguageGo
Program languageGo (Language Count: 3)
Platform
License:MIT License
所有者活动
Created At2016-01-14 07:10:29
Pushed At2025-03-19 17:51:30
Last Commit At
Release Count19
Last Release Namev3.2.1 (Posted on )
First Release Namev0.1.0 (Posted on )
用户参与
Stargazers Count474
Watchers Count5
Fork Count56
Commits Count68
Has Issues Enabled
Issues Count16
Issue Open Count1
Pull Requests Count15
Pull Requests Open Count1
Pull Requests Close Count3
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private