Quickstart Guide

Get Thread Vault CLI running in under 5 minutes. This guide covers the fastest path from zero to your first scrape session.

Prerequisites

🐍

Python 3.13+

Thread Vault requires Python 3.13 or newer. Check with python --version. Download from python.org if needed.

📦

uv Package Manager

The recommended way to install and run Thread Vault. Install with the one-liner below, or use pip with a manual venv.

INSTALL UV (ALL PLATFORMS)
# macOS / Linux $ curl -LsSf https://astral.sh/uv/install.sh | sh # Windows (PowerShell) PS> powershell -c "irm https://astral.sh/uv/install.ps1 | iex"

Full Installation

01
Clone the repository
Download the source code from GitHub.
BASH
$ git clone https://github.com/grep-many/thread-vault-cli.git $ cd thread-vault-cli
02
Sync dependencies
Installs all dependencies from the lock file. Creates a local virtual environment automatically.
BASH
$ uv sync
03
Install Chromium (for Browser Auth)
One-time download of the Playwright-managed Chromium browser. Skip if you plan to use Session ID authentication only.
BASH
$ uv run playwright install --with-deps chromium
04
Launch Thread Vault CLI
Run the application. The TUI loads and the startup screen validates any cached session automatically.
BASH
$ uv run python -m app

Your First Session

Once the application launches, here's what happens and what you do:

1️⃣

Startup Screen

Thread Vault silently checks for a cached session in cache/session.json. If none exists or it's expired, you're routed to the Auth Screen. If valid, you go straight to the Thread Explorer.

2️⃣

Authenticate

Press A for Browser Login (Chromium opens, log in normally, cookies are captured automatically) or B to paste your sessionid cookie value.

3️⃣

Select a Thread

The Thread Explorer lists all your Instagram DM conversations. Use arrow keys to navigate, ctrl+f to search, r to reload from the API, then Enter to select.

4️⃣

Choose a Scope Mode

The Thread Detail screen shows mode options. Press 1 (Media Archive), 2 (Text & Unclassified), or 3 (All Content). Confirm to enter the Scrape Dashboard.

5️⃣

Run the Pipeline

In the Scrape Review Dashboard, press P to start the automatic pipeline — both the scraper and unsend worker run concurrently. Or use S (scrape only) and U (unsend only) for manual control.

6️⃣

Exit & Data Purge

Pressing Escape from the dashboard triggers the data isolation purge — all scraped rows, cursor state, and cache files are deleted from disk. Your session is clean.

⚠
Data is not persistent by design. Thread Vault enforces Session Data Isolation — all scraped message rows are deleted from data/vault.db when you exit the dashboard or log out. If you need to retain data, export from the SQLite database before exiting. See the Export Guide for instructions.

Next Steps