bitpeek
  1. Bitpeek
  2. Tools
  3. Documentation

Bitpeek Technical Documentation & Manual

A complete engineering reference for inspecting raw bytes, analyzing binary structures, generating verifiable evidence, and integrating with CLI or MCP.

Open the workbench Local processing notes

Architecture & Engine Design

Bitpeek is engineered as a client-side, local-first binary workbench. The architecture is strictly decoupled into an algorithmic core and target-specific delivery adapters:

  • packages/core: A pure TypeScript engine containing parsers (ELF, PNG, declarative schemas), byte streaming abstractions (ByteSource), hashing algorithms (FIPS 180-4 SHA-256, CRC-32, CRC-16), offset diffing, and declarative recipe execution. It has zero dependencies on React, the DOM, or Node.js.
  • src/ (Web Workbench): React 19 interface with virtualized hex and ASCII grid rendering, real-time structure tree navigation, bit toggling, and in-memory transactional history.
  • packages/cli: Standalone Node.js CLI executable (bitpeek) providing scriptable JSON output, standard POSIX exit codes, and atomic file writes.
  • packages/mcp: Local Model Context Protocol (MCP) server communicating over stdio, exposing 12 structured tools for autonomous developer agents.

Core Differentiators

Bitpeek was built to solve precision problems found in general-purpose hex editors:

  • Field-to-Byte Semantic Mapping: High-level structural fields (such as ELF section headers or PNG chunk lengths) are mapped directly to exact byte coordinates in the raw binary view.
  • Zero Server Uploads: All byte analysis and manipulation execute entirely within the user's local execution environment. No bytes ever leave your device.
  • Cross-Platform Parity: The exact same TypeScript core powers the web interface, the CLI binary, and the MCP agent server, guaranteeing identical semantic results.
  • Verifiable Evidence & Replay: Export reproducible markdown summaries, JSON evidence reports, and declarative replay recipes suitable for pull requests and bug bounty submissions.

Documentation Index

Explore the specialized documentation sections:

  • Quickstart Guide: Three hands-on tasks to get started in minutes.
  • Byte Semantics: Ranges, endianness, 64-bit integer strings, and float representations.
  • Structure Inspector: ELF32/ELF64, PNG chunk layout, and custom JSON schemas.
  • Patches & Diff: Offset-aligned diff semantics, precondition checks, and atomic apply.
  • Recipes & Replay: Declarative automation pipelines for multi-step transforms.
  • CLI Reference: Terminal commands, arguments, exit codes, and piping.
  • MCP Server: Setup for Claude Desktop, Cursor, and security containment.
  • Limits & Budgets: Memory constraints, streaming chunk sizes, and platform guarantees.
  • Privacy Architecture: Client-only guarantees, CSP enforcement, and data flows.

Local processing and privacy

The Documentation workflow opens the same Bitpeek browser workspace. Selected file bytes, file names, pasted input, searches, edits, hashes, and comparison data are processed in local browser memory and are not sent to a Bitpeek server.

The static guide itself can be read without opening a file or creating an account.

Frequently asked questions

Is Bitpeek free and open source?

Yes. Bitpeek is licensed under the permissive MIT license and hosted openly on GitHub.

Does Bitpeek require an account or API key?

No. Bitpeek requires no login, no accounts, and no paid API keys. All features are fully functional offline once loaded.

Can Bitpeek be used in CI/CD pipelines?

Yes. The bitpeek CLI provides exit code 0 on success, exit code 4 on verification failure, and JSON output for automated scripting.