pickfit

BrowseDeveloper CLIs

shine

Terminal Markdown previewer and docs checker for READMEs, changelogs, and release notes.

Tested on macOS and Linux

Use it

macOS arm64

You need first

  • Runtimes: Go 1.24.2 or newer, Node.js 18+
  1. npm install -g @nk02/shine@0.1.2

    npm install -g @nk02/shine@0.1.2 && shine version
    

Check that it works

shine version

The output should contain “0.1.2”.

First thing to try

shine version

Run shine README.md in a folder with a README to open the interactive preview.

Linux x86_64

You need first

  • Runtimes: Go 1.24.2 or newer, Node.js 18+
  1. install shine via npm

    npm install -g @nk02/shine@0.1.2

Check that it works

shine version

The output should contain “0.1.2”.

First thing to try

shine version

Run shine README.md in a folder with a README to open the interactive preview.

What it does

  • Preview Markdown in the terminal
    How to use it
    1. Run shine --plain <file> to print a Markdown file as plain text.
    Tested
  • Browse a preview with search and an outline
    How to use it
    1. Run shine --outline <file> to show the document's heading outline.
    Tested
  • Check docs for publishing issues
    How to use it
    1. Run shine --check <file> to list Markdown warnings for the file.
    Tested
  • Show local images inline in the terminal
    Not shown working

How far pickfit got

macOS arm64

  1. Installs
  2. Starts
  3. 3 of 4 features work
  4. Works offline

Linux x86_64

  1. Installs
  2. Starts
  3. 3 of 4 features work
  4. Works offline

Good for

  • preview a README in the terminal
  • check README for common docs issues
  • show document heading outline
  • print plain text output without styling
  • preview Markdown from stdin

How pickfit tested it

Each run starts from a clean machine and follows the steps above. How pickfit verifies

macOS arm64

Its main function works

  • Replayed from scratch
  • Works offline
  • Checked on 1 Nov 2026
  • Version 0.1.2

Linux x86_64

Its main function works

  • Replayed from scratch
  • Works offline
  • Checked on 1 Nov 2026
  • Version 0.1.2

Differences the test machine hit

  • README: shine --check README.md returns docs warnings
    In the test: exit code 2 when warnings found (not 0) – expected behavior per --help

How to read a tool card

Stitching
pickfit installed this tool itself. Everything under the stitches comes from that run. A tool pickfit has not run never gets stitches.
Verified on your OS
The install steps ran on the system you chose. “Ran on Linux only” means it has not been run on yours yet.
macOS, Linux and WindowsWhere it ran
Green OS marks: pickfit ran the install steps there. Grey ones: the README says it runs there, and pickfit has not tried.
How far the run got
Installs and starts, its main function works, its service answers, it produces model output. A window means a desktop app opened; a plug, an MCP client used it. The mark sits beside the run’s result, under “Why it fits and how we know” and in “How pickfit tested it”.
Visual check
pickfit looked at screenshots of the app. Green: it looks right. Amber with a number: things that look wrong; open it to see them. Grey and dashed: not checked yet.
Known vulnerabilities
Known high or critical vulnerabilities (OSV.dev) in what it installs. Green: none known. Red with a number: how many; open it for the list, and read it before you install. Grey and dashed: not checked, which does not mean safe.
About the run
The day it ran, and the version that ran.
Source of a reason
Every reason a pick fits rests on one profile field. Open the reason to see the field and the value it relies on.
Hidden gem
High quality, little known.
Quality and popularity
Two scores out of 100. Quality: how well it installed and worked when pickfit tried it, and how good its install docs and upkeep are. Popularity: from stars, downloads and Hacker News.
Features checked
Of the main features the README advertises, how many the run actually exercised (green), and how many failed (red). Grey ones were not checked, and the card says why.
Not verified
A well-known tool Fitz mentions from general knowledge. No run record, no steps, no score.