PacketBenchDocs

Install PacketBench#

PacketBench is a Tauri desktop application. Build it on the computer where you will run it.

Before you start#

  • Git.
  • Node.js and pnpm 9.
  • A current Rust toolchain.
  • The Tauri system prerequisites for your platform: WebView2 and MSVC build tools on Windows, Xcode command-line tools on macOS, or WebKitGTK development packages on Linux.
  • Enough disk space for Rust build output and the bundled Node sidecar.

Build and run from source#

git clone https://github.com/packetloss404/PacketBench.git
cd PacketBench
pnpm install
pnpm tauri dev

The first install also installs the agent-sidecar dependencies. The development command opens a desktop window backed by the local source tree.

To produce platform packages:

pnpm tauri build

The production build fetches its pinned Node runtime, builds the sidecar, prunes the sidecar's development dependencies and runs the release gate before Tauri creates the packages supported by the host platform. Run pnpm sidecar:install afterwards to restore those development dependencies.

Verify#

  1. Open PacketBench and confirm the title bar renders without a recovery error.
  2. Open Settings and confirm the application reports version 0.14.0.
  3. Open Settings → Security & Diagnostics → Trust & Diagnostics and confirm the Storage durability card reports the durable mirror as active and no failed migration.
  4. Create a temporary workspace and open a Terminal pane.
  5. Run a harmless command such as git --version.

A new installation runs no project-supplied hooks, .mcp.json servers or .claude/agents definitions until you list that project in ~/.packetbench/trusted-projects.json. Agent conversations also start in ask_for_risky permission mode, so bash, write_file, edit_file and create_pull_request prompt before they run.

If the desktop opens but agent conversations fail, finish provider setup in Configuration. If the application reports a missing sidecar or Node runtime, use Troubleshooting.

Before a production build#

Run the repository checks from a clean checkout:

pnpm gates:fast
pnpm rust:test

pnpm gates:fast runs format, lint, typecheck and the frontend test suite and reports every gate instead of stopping at the first failure. pnpm gates:full covers the whole local surface, including end-to-end, sidecar and Rust checks. The serial equivalents pnpm preflight and pnpm check remain available; pnpm preflight now also builds and tests the remote-agents workspace.

If a previous interrupted build left the checkout without its development dependencies, run pnpm install before retrying.

Code signing and distribution are separate release-operator responsibilities; a locally built installer should not be assumed to be signed.

If it does not work#

Symptom Check Recovery
The build fails before the app appears The toolchain versions in the prerequisites above A desktop build needs more than Node; a missing native toolchain fails late and confusingly
It builds but the desktop never opens The startup log first See The desktop does not open
It opens with no settings from a previous install Whether the data directory moved See Settings or workspaces are missing after an upgrade
A terminal pane closes the moment it opens The configured shell See A terminal pane closes immediately