> ## Documentation Index
> Fetch the complete documentation index at: https://docs.papermap.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Install the TUI

> Install Papermap TUI with Homebrew, the install script, Go, or a source build.

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

## Installation options

<CodeGroup>
  ```bash Homebrew theme={null}
  brew install papermap-ai/papermap/papermap

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

  ```bash Tap theme={null}
  brew tap papermap-ai/papermap
  brew install papermap
  ```

  ```bash Script theme={null}
  curl -fsSL https://raw.githubusercontent.com/Papermap-ai/papermap-tui/main/install.sh | sh
  ```

  ```bash Go theme={null}
  go install github.com/papermap/papermap-tui/cmd/papermap@latest
  ```

  ```bash Source theme={null}
  git clone https://github.com/Papermap-ai/papermap-tui.git
  cd papermap-tui
  make build
  ./bin/papermap
  ```
</CodeGroup>

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

## 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.

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

## Verify installation

```bash theme={null}
papermap --version
papermap --help
```

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

```text theme={null}
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

<Steps>
  <Step title="Sign in">
    ```bash theme={null}
    papermap auth login
    ```
  </Step>

  <Step title="Launch Papermap">
    ```bash theme={null}
    papermap
    ```
  </Step>

  <Step title="Ask your first question">
    Type a data question and press `Enter`. Papermap streams the response into the terminal transcript.
  </Step>
</Steps>

## Build from source

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

```bash theme={null}
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.

<Tip>
  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`.
</Tip>

## Next steps

<CardGroup cols={2}>
  <Card title="Authenticate" icon="key" href="/documentation/tui/authentication">
    Sign in with browser login or terminal password fallback.
  </Card>

  <Card title="Navigate the TUI" icon="compass" href="/documentation/tui/navigation">
    Learn shortcuts, overlays, streaming, shell mode, and model switching.
  </Card>
</CardGroup>