Quickstart

Get ntrp running in 5 minutes.

Prerequisites

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

Install

From package registries

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

From source

git clone https://github.com/esceptico/ntrp.git
cd ntrp
uv sync                              # Python backend
cd ntrp-ui && bun install && cd ..   # TUI client

Set up

1. Set your LLM provider (optional)
2. You can export a provider API key now, or configure a provider interactively in the TUI after connecting. OpenAI can be used either with an API key or with browser sign-in through the OpenAI Codex provider.
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. If you want to use an OpenAI subscription/account instead of an API key, skip the key export and choose OpenAI Codex in provider onboarding. ntrp opens a browser sign-in and stores refreshable OAuth tokens in ~/.ntrp/openai-codex-auth.json.
5. Start the server
6. From source

   From source

   uv run ntrp-server serve
   

   Installed

   From source

   ntrp-server serve
   
7. On first run, ntrp generates an API key and prints it:
8. Your API key: nBx7k2...
   Enter this in the TUI to connect. It won't be shown again.
   

9. Copy this key — it’s only shown once. Use ntrp-server serve --reset-key to generate a new one.
10. Start the TUI
11. In a separate terminal:
12. Installed

    Installed

    ntrp
    

    From source

    Installed

    cd ntrp-ui
    bun run start
    
13. 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.