An open API service indexing awesome lists of open source software.

https://github.com/tig/winprint

Human and AI Agent friendly print utility with syntax highlighting, multiple pages-up, headers/footers. Cross platform (Mac, Linux, Windows) GUI and TUI. Print source code, web pages, and reports generated by legacy systems.
https://github.com/tig/winprint

csharp dotnet linux lpr macos print printing source-code syntax-highlighting text-files tui windows windows-app

Last synced: 4 days ago
JSON representation

Human and AI Agent friendly print utility with syntax highlighting, multiple pages-up, headers/footers. Cross platform (Mac, Linux, Windows) GUI and TUI. Print source code, web pages, and reports generated by legacy systems.

Awesome Lists containing this project

README

          

[![GitHub Release](https://img.shields.io/github/v/release/tig/winprint)](https://github.com/tig/winprint/releases)
[![CodeFactor](https://www.codefactor.io/repository/github/tig/winprint/badge?s=93affda0738af869187afe5296914b814511f529)](https://www.codefactor.io/repository/github/tig/winprint)

# WinPrint

*A modern take on the classic source code printing app from [1988](https://tig.github.io/winprint/about.html).*

Human and AI Agent friendly print utility with syntax highlighting, multiple pages-up, headers/footers. Cross platform (Mac, Linux, Windows) GUI, TUI, and CLI. Print source code, web pages, and reports generated by legacy systems.

### Terminal UI (`wp`)

wp TUI — sixel print preview

*The `wp` terminal UI renders true print previews as sixel/kitty graphics, without leaving the terminal: page through a document, zoom in, pan with the mouse, switch sheet definitions, and open another file.*

### Headless print (`wp print`)

wp print — CLI without the UI

*Print (or dry-run with `--what-if`) straight from the shell — same sheet/printer options as the TUI and GUI.*

### Graphical UI (`wp gui`)


WinPrint GUI on Windows
WinPrint GUI on macOS

*The GUI on Windows (left) and macOS (right): visual print preview, settings, and `wp gui` to launch from the terminal.*

## Installation

### Windows

Install with [winget](https://learn.microsoft.com/windows/package-manager/winget/) — one command gives you both the GUI and the `wp` terminal UI:

```powershell
winget install Kindel.WinPrint
```

Or download the signed installer **`Kindel.WinPrint-win-x64-Setup.exe`** from the
[latest release](https://github.com/tig/winprint/releases/latest) and run it. (On new releases
SmartScreen may say it "isn't commonly downloaded" — that's a reputation check, not a signing
problem; the publisher reads *Kindel, LLC*. See the [Installation Guide](https://tig.github.io/winprint/install.html#install-from-github-releases-download-the-installer).)

### macOS

```bash
brew tap kindel/winprint
brew install winprint # WinPrint GUI app — also bundles the `wp` terminal UI
```

### Linux

```bash
brew install kindel/winprint/wp # `wp` terminal UI (the GUI is Windows/macOS only)
```

See the [Installation Guide](https://tig.github.io/winprint/install.html) for detailed instructions, prerequisites, and upgrade/uninstall steps.

## Getting Started

Launch the TUI:

```bash
wp
```

Launch the GUI on Windows or macOS:

```bash
wp gui
```

You can also find **WinPrint** in the Start Menu (Windows) or via Spotlight (macOS).

## Features

* Prints source code in hundreds of programming languages with syntax highlighting and line numbering.
* Prints HTML files.
* Prints "multiple-pages-up" on one piece of paper (saves trees!)
* Complete control over page formatting options, including headers and footers, margins, fonts, page orientation, etc.
* Headers and Footers support detailed file and print information macros with rich date/time formatting.
* Simple and elegant graphical user interface with accurate print preview on Windows and macOS.
* `wp` provides a terminal UI on Windows, macOS, and Linux.
* `wp gui` launches the GUI on Windows and macOS.
* Sheet Definitions make it easy to save settings for frequent print jobs.
* Comprehensive logging.
* Cross-platform TUI; Windows and macOS GUI; Linux GUI is deferred.

## Documentation

* [Overview](https://tig.github.io/winprint/)
* [Installation Guide](https://tig.github.io/winprint/install.html)
* [User's Guide](https://tig.github.io/winprint/users-guide.html)
* [About](https://tig.github.io/winprint/about.html)
* [Support](https://tig.github.io/winprint/support.html)

## Graphical Interface

The GUI is available on Windows and macOS via `wp gui`.

![WinPrint](https://tig.github.io/winprint/winprint2.png)

## Command Line Interface

Open a file in the terminal UI:

```bash
wp Program.cs
```

Pass print preview options:

```bash
wp Program.cs --printer "Microsoft Print to PDF" --sheet "Default 2-Up"
```

Launch the GUI:

```bash
wp gui
```

Print headlessly:

```bash
wp print Program.cs --what-if --sheet "Default 2-Up"
```

See the [User's Guide](https://tig.github.io/winprint/users-guide.html) for complete CLI documentation.

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup, build instructions, and release process.