WireCatLabs/cli-core

The engine behind the WireCat command-line tools for Telegram, MAX, WhatsApp, mail, notes, meetings and Google
Drive. Everything that
does not depend on one messenger lives here: the data model, a local SQLite store with full-text and semantic
search, a Lucene query language, the shared commands, an MCP server for AI agents, and the guard around every
write. A messenger plugs in as one adapter and gets all of it.
Architecture · Write an adapter ·
Query language · Messenger rules ·
API reference · Changelog · wirecat.dev
## Key documents
| Document | What it answers |
| Architecture | The layers, the module map, the store internals and migrations, who consumes what |
| Document workflows | Shared file ingestion, sync, scoped knowledge and extraction; the ports a file provider supplies |
| Media archives | Independent verified file copies, interruption recovery and opt-in daily timers |
| Write an adapter | How to add a messenger: the port, the Messenger description, the contract cases |
| Messenger rules | What binds tg, max and wa beyond the CLI standards handbook: parity, the option catalogue, bot |
| Glossary | One word, one meaning across the tools |
| Query language · spec · Image search | The search syntax and its exact grammar; finding pictures by context and by what they show |
| Mentions · how they work | Phones, e-mail, links, documents and names found in messages: search, review, rebuild; the tables and the rules |
| Storage | The schema, the search indexes and the decisions behind them |
| Knowledge · Meetings | Labels, links and proposals across sources; the meetings module and its providers |
| Testing · Parity audit | The sandbox, the coverage floor, the checks across tg and max |
| Tool boundaries | Which tool owns which command |
| API reference | Every entry point and the detailed contract of each feature |
| Roadmap | What is being built next for developers on this package |
| Changelog | What each version changed, and what may break callers |
## What it is
A messaging CLI has two halves. One speaks a protocol: MTProto for Telegram, a WebSocket for MAX, IMAP for mail.
The other half is the same for every messenger: store what was read, search it, render it for a person and as JSON
for a program, guard every send, expose it all to an agent. This package is the second half.
tg-cli, max-cli and
the WhatsApp tool are built on it, and so are the mail and notes tool
cli-memo, zoom-cli and
drive-cli. They import it as @wirecat/cli-core. Up to 0.261.0 the package
was named @wirecat/cli-messaging, which is deprecated. The npm versions 0.0.0-stage, 0.0.0 and 0.18–0.20 of
@wirecat/cli-core are deprecated too: they are placeholders and the old cli-base.
Who it is for. First of all, it is the engine of the WireCat tools, and it changes as fast as they need. You can
build your own messenger CLI on it, but expect to follow a moving API (see Build on it).
sh
npm install --save-exact @wirecat/cli-core
npm 7+ and pnpm also install its peers: @wirecat/cli-base in the range package.json names, and commander 15 or
later. @napi-rs/canvas is optional; charts need it only for PNG output.
It is built on @wirecat/cli-base, the layer every CLI needs: two output