Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ntrp.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Prerequisites

  • Python 3.13+ with uv
  • Bun runtime
  • An LLM provider: Anthropic, OpenAI, or Google — can be configured during setup

​
Install

uv tool install ntrp    # Python backend (PyPI)
bun install -g ntrp-cli # TUI client (npm)

​
Set up

1
Set your LLM provider key (optional)
2
You can export a provider API key now, or configure it interactively in the TUI after connecting.
3
# Pick one (or skip and configure in the TUI):
export ANTHROPIC_API_KEY=sk-ant-...
export OPENAI_API_KEY=sk-...
export GEMINI_API_KEY=...
4
Start the server
5
From source
uv run ntrp-server serve
Installed
ntrp-server serve
6
On first run, ntrp generates an API key and prints it:
7
Your API key: nBx7k2...
Enter this in the TUI to connect. It won't be shown again.
8
Copy this key — it’s only shown once. Use ntrp-server serve --reset-key to generate a new one.
9
Start the TUI
10
In a separate terminal:
11
Installed
ntrp
From source
cd ntrp-ui
bun run start
12
Paste your API key in the connection dialog. If no LLM provider is configured, a provider setup screen appears where you can connect a provider and choose a default model.

​
What’s next?

TUI Guide

Keyboard shortcuts and slash commands.

Configuration

Customize models, enable integrations, and tune settings.

Memory

Understand how ntrp remembers things.

Connect Gmail

Let ntrp read and send emails.