Install the TUI

Install the papermap command, sign in, then launch the terminal interface.

Installation options

brew install papermap-ai/papermap/papermap

# Alias formula
brew install papermap-ai/papermap/tui

brew tap papermap-ai/papermap
brew install papermap

curl -fsSL https://raw.githubusercontent.com/Papermap-ai/papermap-tui/main/install.sh | sh

go install github.com/papermap/papermap-tui/cmd/papermap@latest

git clone https://github.com/Papermap-ai/papermap-tui.git
cd papermap-tui
make build
./bin/papermap

The install script downloads the latest release, verifies its SHA256 checksum, and installs to /usr/local/bin or ~/.local/bin.

Install a specific version

Use VERSION when you need a pinned release. Use PREFIX when you want to install somewhere other than the default location.

PREFIX=$HOME/.local VERSION=v0.0.1 \
  curl -fsSL https://raw.githubusercontent.com/Papermap-ai/papermap-tui/main/install.sh | sh

Verify installation

papermap --version
papermap --help

You should see the installed version and the supported command list.

papermap [flags]              Launch the interactive TUI
papermap auth login           Sign in to Papermap (opens browser)
papermap auth logout          Sign out and clear local credentials
papermap auth whoami          Show the signed-in user
papermap workspace create     Create a database-backed workspace
papermap workspace list       List workspaces visible to the signed-in user

First launch

papermap auth login

Launch Papermap

papermap

Ask your first question

Type a data question and press Enter. Papermap streams the response into the terminal transcript.

Build from source

If you are developing the TUI locally, use the Makefile commands from the TUI repository.

make build              # build into ./bin/papermap
make run                # go run ./cmd/papermap
make test               # go test ./... -race
make fmt                # gofumpt + goimports
make lint               # golangci-lint run
make release-snapshot   # local GoReleaser snapshot build

Supported platforms

Release builds target macOS and Linux on amd64 and arm64. The Go install path can also build wherever Go and the TUI dependencies are supported.

If papermap installs successfully but your shell cannot find it, confirm that /usr/local/bin, ~/.local/bin, or your Go binary path is in PATH.

Next steps

Authenticate

Navigate the TUI

Learn shortcuts, overlays, streaming, shell mode, and model switching.

Getting Started

Terminal UI

Embedding

Multi-Tenancy

Installation options

Install a specific version

Verify installation

First launch

Build from source

Supported platforms

Next steps

Authenticate

Navigate the TUI

​Installation options

​Install a specific version

​Verify installation

​First launch

​Build from source

​Supported platforms

​Next steps

Authenticate

Navigate the TUI

Installation options

Install a specific version

Verify installation

First launch

Build from source

Supported platforms

Next steps