hitsword
/
wx-cli
mirror of https://github.com/jackwener/wx-cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
wx-cli/.gsd/PROJECT.md

1.8 KiB
Raw Blame History

wx-cli

What This Is

A cross-platform Rust CLI tool for extracting and querying local WeChat 4.x data. Decrypts SQLCipher-encrypted databases, caches decrypted copies with mtime-aware invalidation, and provides a daemon-based IPC architecture for fast repeated queries. Supports Unix sockets (macOS/Linux), Windows named pipes, and TCP for remote access.

Core Value

Query your local WeChat chat history, contacts, and moments from the command line with millisecond response times — data never leaves your machine.

Project Shape

  • Complexity: simple
  • Why: Well-defined scope, existing codebase with clear module boundaries, trait-based transport abstraction

Current State

Version 0.1.10. Fully functional CLI with 17 subcommands. Daemon auto-starts on first query. Cross-platform (macOS, Linux, Windows). TCP transport added with trait-based abstraction (Listener/Connector traits). Integration tests cover TCP round-trip, connection refused, and TCP-vs-local comparison. Local IPC + TCP simultaneously supported.

Architecture / Key Patterns

  • Single binary: client and daemon (WX_DAEMON_MODE env var)
  • Daemon uses tokio async runtime, Unix socket / Windows named pipe / TCP IPC
  • Transport abstraction via Listener and Connector object-safe traits
  • Generic handle_connection function shared across all transport types
  • JSON-line protocol: one request per connection
  • Blocking std::net::TcpStream for TCP transport (matches sync CLI architecture)
  • mtime-aware decryption cache in ~/.wx-cli/cache/
  • Platform-specific memory scanners for SQLCipher key extraction
  • All queries executed via rusqlite on decrypted DBs

Capability Contract

See .gsd/REQUIREMENTS.md for the explicit capability contract.

Milestone Sequence

  • M001: TCP Transport — Add --tcp host:port global flag and TCP transport support to daemon and client