cliqr

package module
v0.1.24 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 14, 2024 License: BSD-3-Clause Imports: 3 Imported by: 0

README

OVERVIEW

Go Reference Go Report Card Go Build

paepcke.de/cliqr

Display QR codes on your console to secure transfer locally:

  • keys, secrets, access token
  • (small-ec-based) certificates
  • urls, uris
  • wifi creds
  • code fragments

KEYPOINTS

  • minimal code, static, dependency free
  • backend is a boiled-down fork of skip2/go-qrcode (ALL CREDIT GOES THERE!)
  • 100% pure go, stdlib only, use as app or api (see api.go)

INSTALL

go install paepcke.de/cliqr/cmd/cliqr@latest
DOWNLOAD (prebuild)

github.com/paepckehh/cliqr/releases

SHOWTIME


cliqr "mailto:potus@wh.gov"
[...]

cliqr "WIFI:S:$my-ssid;T:WPA;P:$my-password"
[...]

cat /etc/ssh/ssh-ed25519-key | cliqr
[...]

echo "MYSUPERSECRETPASSWORD" | cliqr
[...]

echo $BTC | cliqr
[...]

DOCS

pkg.go.dev/paepcke.de/cliqr

CONTRIBUTION

Yes, Please! PRs Welcome!

Documentation

Overview

package cliqr provides a minimal static package to convert strings into console QRcodes

2022/05/10 paepcke.de/internal/crq [forked|inspired] by github.com/skip2/go-qrcode MIT

WARNING: THIS IS AN HEAVYLY [MODIFIED|OPTIMIZED|MINIMAL] NOT API/RESULT COMPATIBLE FORK! DO NOT USE THIS FORK OUTSIDE THIS PACKAGE! ALL CREDITS GOES TO THE ORIGINAL AUTHOR(S)!

PLEASE ALWAYS USE THE ORIGINAL SOURCE!

ALL CREDIT GOES TO THE AUTHOR(S)!

github.com/skip2/go-qrcode MIT LICENSE

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func QR

func QR(in string) string

QR converts an string into an auto-sized console qr code

func QRbig

func QRbig(buf string) string

QRbig tries always to scale big

func QRsmall

func QRsmall(buf string) string

QRsmall tries always to scale small

Types

This section is empty.

Directories

Path Synopsis
cmd

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL