Documentation

Tomoshibi Documentation

Self-hosted scraping API — one binary, $5/mo infra. This hosted playground is rate-limited and ephemeral. For unlimited use, run it locally with Docker.

Quick Start

Run with Docker

One command. All 5 services on 7431–7435. Recommended.

Try Playground

Test scrape / crawl / search in the browser (limited).

API Reference

POST /v1/scrape, /v1/crawl, /v1/search — with examples.

Technology Stack

API

Go 1.25+ · Gin Runtime

Chromedp + Colly Engines

SearXNG + Redis Search & Queue

Web Playground

SvelteKit 5 Framework

shadcn-svelte UI

Tailwind v4 Styling

MCP

tomoshi CLI npm

3 tools scrape · crawl · search

MCP SDK Protocol

Self-host

Docker Compose Recommended

Fly / Render Hobby tier

MIT · No telemetry License

Key Principles

Self-hosted by default

Your data never leaves your VPC. One binary + Redis + SearXNG. No per-token billing.

Fast by design

Shared Chromedp allocator, recycled tabs, smart static→dynamic fallback. ~200ms static, parallel pools.

LLM-ready output

Readability main-content + ad block → clean markdown, metadata, links, optional screenshot.

Open & funded by you

MIT licensed. Stars drive discovery, sponsors fund Chromedp & SearXNG upkeep. See FUNDING.yml.

Documentation

Quick Start (Docker)

Clone and docker compose up -d — 30 seconds to markdown.

API Reference

Scrape, crawl, batch, search, map — request & response shapes.

Self-hosting & Deploy

Fly, Render, Docker Hub / GHCR, env vars, and health checks.

Need Help?

Check out the setup guide to get started, explore the architecture to understand how everything works, or browse the features to see what's possible.

Open Playground View Setup Guide