Skip to content

Repository files navigation

TermPlot

Interactive Plotly figures inside Astrohacker TermSurf. Pipe Plotly JSON or open a JSON file, explore the overlay, and press Esc to keep a still image in the terminal scrollback.

This implementation replaces the former TermPlot renderer and the bundled ahplt command. It is installed separately, but plotting currently requires Astrohacker TermSurf. Support for other terminals is not implemented here. The older TermPlot Nushell plugin/module API is not a compatibility contract.

Installation

Independent Homebrew release qualification is in progress. Once the new formula is published, on a supported Apple-silicon Mac:

brew tap astrohackerlabs/termplot
brew trust astrohackerlabs/termplot
brew install astrohackerlabs/termplot/termplot
termplot --version
termplot --help

Install Astrohacker TermSurf separately. The formula does not install or own TermSurf. Running this prebuilt package does not require Bun, Node or Playwright. If an older installation owns termplot on PATH, identify and uninstall or unlink that package first; do not force-overwrite its files.

Inside an Astrohacker TermSurf pane:

'{"data":[{"x":[1,2,3],"y":[2,1,4],"type":"scatter"}]}' | termplot
termplot --file plot.json

--width and --height set maximum overlay dimensions in terminal cells. Identity/help work outside TermSurf; plotting does not.

Build from source

The standalone source includes only TermPlot and its required shared UI. Install Bun, then from this checkout:

bun install --frozen-lockfile
bun run typecheck
bun run build
code/termplot/ts/termplot/dist/termplot --version

Keep dist/termplot, build/client, public, and package.json together under the package root. The executable resolves Homebrew-style symlinks to find those resources. bun run test includes a development screenshot test that requires Playwright's browser; that is not a product runtime dependency.

License and history

Astrohacker first-party code is MIT-licensed; see LICENSE. Third-party runtime components retain their own licenses. Release archives carry notices alongside the executable and resources. Earlier TermPlot source remains in Git history. The existing public website/ and historical issue records are preserved; they describe the earlier implementation and are not the new install contract.

About

Beautiful plots in your terminal.

Resources

Stars

35 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages