Docs › Guide

Getting Started

Learn how to set up Docsieve locally or via the hosted cloud platform.

Docsieve is an intelligent, automated documentation crawler and parsing pipeline designed to help developers and technical writers compile, version, and digest large-density documentation sets.

Installation

You can get started with Docsieve in two ways: using the hosted cloud platform or deploying the open-source CLI locally.

The easiest way to use Docsieve is on our secure, hosted cloud platform at app.docsieve.helpersetu.com.

  • No installation required.
  • Standard SSO sign-in via Google, Microsoft, or Apple.
  • Real-time crawl progress streams (SSE-based).
  • Automatic IndexedDB local storage cache for offline reading.

2. Local CLI Installation

If you prefer to run crawls on your local machine or integrate them into CI/CD pipelines, install the open-source CLI:

pip install docsieve

Running Your First Crawl

Via the Web UI

  1. Open app.docsieve.helpersetu.com and sign in.
  2. In your workspace home segment, locate the prominent Crawl new documentation site URL input field.
  3. Enter the target documentation URL (e.g. https://docs.fastapi.tiangolo.com).
  4. Click Crawl.
  5. The interface will switch to the Crawl Progress Screen, showing real-time updates as pages are queued, checked against robots.txt, extracted, and compiled into the executive brief.

Via the CLI

To trigger a documentation compile run from your terminal:

docsieve crawl https://docs.fastapi.tiangolo.com --output ./fastapi-brief.md

Reading the Output

Once the crawl completes, Docsieve outputs three structured components:

  • Executive Brief: A high-level synthesized summary of the documentation corpus, highlighting main concepts and structural components.
  • Table of Contents: A hierarchical, navigable index of all crawled pages.
  • ZIP Download: A structured archive containing clean, stripped Markdown files for every crawled page.