GistTree.Com
Entertainment at it's peak. The news is by your side.

Glow: Markdown reader for the terminal with a TUI and encrypted cloud stash

0

Render markdown on the CLI, with pizzazz!

Glow Logo
Latest Release
GoDoc
Build Status
Go ReportCard

Glow UI Demo

What is it?

Glow is a terminal essentially based fully mostly markdown reader designed from the ground up to bring
out the class—and energy—of the CLI.

Use it to seem markdown recordsdata, be taught documentation without prolong on the squawk
line and stash markdown recordsdata to your maintain non-public sequence so that which it’s doubtless you’ll perhaps be taught
them anyplace. Glow will catch native markdown recordsdata in subdirectories or a local
Git repository.

By the formula, all recordsdata stashed is encrypted cease-to-cease: biggest which it’s doubtless you’ll perhaps decrypt it.
More on that below.

Installation

Use your fave bundle manager:

# macOS or Linux
brew install glow

# Arch Linux (btw)
yay -S glow

# Void Linux
xbps-install -S glow

# Nix
nix-env -iA nixpkgs.glow

# FreeBSD
pkg install glow

Or download a binary from the releases page. MacOS, Linux, House windows,
FreeBSD, and OpenBSD binaries are on hand, as smartly as Debian, RPM, and Alpine
purposes. ARM builds are also on hand for Linux, FreeBSD, and OpenBSD.

Or actual form it yourself (requires Go 1.13+):

git clone https://github.com/charmbracelet/glow.git
cd glow
glide form

The TUI

Simply bustle glow without arguments to originate the textual consumer iterface and
browse native and stashed markdown. Glow will catch native markdown recordsdata it the
fresh listing and below or, in case you’re in a Git repository, Glow will search
the repo.

Markdown recordsdata would possibly per chance be be taught with Glow’s high-performance pager. Hundreds of the
keystokes you already know from much less are the the same, but which it’s doubtless you’ll perhaps press ? to listing
the hotkeys.

Stashing

Glow works with the Allure Cloud to permit you to store any markdown recordsdata in
your maintain non-public sequence. You would possibly per chance perhaps stash a local doc from the Glow TUI by
urgent s.

You would possibly per chance perhaps also stash from the CLI:

Then, whereas you occur to bustle glow without arguments will which it’s doubtless you’ll perhaps browse through your
stashed documents. Here’s a colossal formula to preserve display screen of issues that you simply have gotten gotten to
reference on the entire.

Stashing is non-public, its contents will no longer be exposed publicly, and it be
encrypted cease-to-cease. More on encryption below.

The CLI

To boot to a TUI, Glow has a CLI for working with Markdown. To structure a
doc use a markdown source because the principle argument:

# Learn from file
glow README.md

# Learn from stdin
glow -

# Safe README from GitHub / GitLab
glow github.com/charmbracelet/glow

# Safe markdown from HTTP
glow https://host.tld/file.md

Stashing

You would possibly per chance perhaps also stash documents from the CLI:

Then, whereas you occur to bustle glow without arguments will which it’s doubtless you’ll perhaps browse through your
stashed documents. Here’s a colossal formula to preserve display screen of issues that you simply have gotten gotten to
reference on the entire.

Be aware Wrapping

The -w flag implies that you simply can keep a most width at which the output can be wrapped:

Paging

CLI output would possibly per chance be displayed for your preferred pager with the -p flag. This defaults
to the ANSI-aware much less -r if $PAGER is now not any longer explicitly keep.

Styles

You would possibly per chance perhaps get rid of a model with the -s flag. When no flag is equipped glow tries
to detect your terminal’s fresh background coloration and robotically picks
both the darkish or the light model for you.

Alternatively which it’s doubtless you’ll perhaps also provide a custom JSON stylesheet:

For additional usage particulars see:

Take a look at out the Glamour Style Portion
to catch extra styles. Or affect your maintain!

🔒 Encryption: How It Works

Encryption works by issuing symmetric keys (veritably a generated password) and
encrypting it with the native SSH public key generated by the open-source
charm library. That encrypted key’s then despatched up to our server.
We can’t be taught it since we don’t maintain your individual key. In the occasion you’ll need to decrypt
one thing or survey your stash, that key’s downloaded from our server and
decrypted in the neighborhood the usage of the SSH non-public key. In the occasion you hyperlink accounts, the
symmetric key’s encrypted for every novel public key. This occurs to your
machine and no longer our server, so we by no formula see any unencrypted recordsdata.

License

MIT

Phase of Allure.

the Charm logo

Charm热爱开源! / Allure loves open source!

Read More

Leave A Reply

Your email address will not be published.