discrawl/docs/README.md
2026-05-05 19:16:52 -07:00

2.2 KiB

Discrawl

Mirror Discord guilds into local SQLite. Search server history without depending on Discord search. Bring a bot token, or read everything offline from a Git snapshot.

What it does

  • discovers every guild a bot can access and syncs channels, threads, members, and message history into SQLite
  • maintains FTS5 indexes for fast literal search; optional embeddings for semantic and hybrid recall
  • imports classifiable Discord Desktop cache messages with wiretap, including proven DMs under @me
  • tails the Gateway for live updates with periodic repair sweeps
  • publishes the archive as sharded NDJSON snapshots in a private Git repo so readers can search offline with no Discord credentials
  • exposes read-only SQL, channel/member directories, mention queries, digests, and trend analytics

Pick your path

  • New here? Read Install and run discrawl init.
  • Already have a bot? Jump to sync and search.
  • Just want to read a shared archive? Use subscribe - no token needed.
  • Need DM search? wiretap imports local Discord Desktop cache.
  • Want semantic search? Configure Embeddings, then run embed.
  • Wiring an agent or launcher? discrawl metadata --json, discrawl status --json, and discrawl doctor --json expose the read-only crawlkit control surface.

At a glance

export DISCORD_BOT_TOKEN="..."
discrawl init
discrawl doctor
discrawl sync --full
discrawl search "panic: nil pointer"
discrawl tail

discrawl tui uses the shared crawlkit terminal explorer: channel/person/thread groups on the left, message rows in the middle, and readable message/thread detail on the right.

Sections

  • Start - install, configure, set up the Discord bot, security notes, contact
  • Guides - sync sources, wiretap internals, search modes, embeddings, Git snapshots, data layout
  • Commands - one page per CLI command

Where to file issues

https://github.com/openclaw/discrawl/issues. See contact for project links.