Skip to content
ThreadLens Docs

ThreadLens Documentation

ThreadLens is self-hosted research intelligence for finding product opportunities in real conversations across Reddit, Bluesky, and Google Search. These docs help you run ThreadLens locally, configure providers safely, create your first project, understand scouting results, and contribute to the public repository.

Get Started

Section titled “Get Started”

Recommended for most self-hosted users:

Terminal window
npx create-threadlens-app@latest

The installer creates a local ThreadLens app directory, starts Docker, checks readiness, and opens the setup wizard.

If you want the manual repository path instead, clone github.com/threadlenshq/threadlens and run these commands from the repository root:

Terminal window
pnpm install
pnpm run docker:dev
pnpm run self-host:smoke

The development profile starts the Go API at http://localhost:4749 and the web app at http://localhost:4748.

First-run checklist

Section titled “First-run checklist”

Follow this sequence for your first useful self-hosted run:

  1. Understand what ThreadLens does and what the current self-hosted release includes.
  2. Run ThreadLens with Docker and verify the local web app and API are reachable.
  3. Configure provider keys so AI workflows and your chosen scouting source can produce useful results.
  4. Reach first value in 15 minutes by completing setup, creating one research project, adding one narrow query, running one scout, and inspecting findings.
  5. Create your first project when you want the slower walkthrough with more context.
  6. Review scouting sources when you are ready to add Google or Bluesky credentials and compare source behavior.
  7. Generate reports after you have enough high-signal findings to summarize.

Public documentation sections

Section titled “Public documentation sections”

The sidebar is organized for two audiences:

  1. Users who want setup, configuration, scouting workflows, schedules, reports, and reference material.
  2. Contributors and public maintainers who need architecture context, testing commands, docs rules, package boundaries, release hygiene, Docker image notes, and support triage.

docs/ is publishable by default in the public repository. Private hosted SaaS runbooks, credentials, billing provider details, private customer data, and proprietary roadmap notes do not belong in this docs tree.

Privacy and telemetry

Section titled “Privacy and telemetry”

ThreadLens includes an optional, anonymous telemetry pipeline. Telemetry is off by default and requires explicit opt-in at both the infrastructure and UI level. See Telemetry for details.

Section titled “Related sites”