Skip to main content

Local Development Environment Setup

Technical details for developers who want to understand PATH's development environment.

Development Environment Architecture​

PATH's development mode uses a Kubernetes-based local development environment with Tilt.

We use Kind (Kubernetes in Docker) for running the local Kubernetes cluster, as it provides better compatibility with Tilt's image building process compared to Docker Desktop's Kubernetes cluster.

Installed Tools​

Tools installed by make install_tools:

  • pocketd CLI: CLI for interacting with Pocket Network's Shannon protocol
  • Docker: Container runtime
  • Kind: Local Kubernetes cluster
  • kubectl: CLI for interacting with Kubernetes
  • Helm: Package manager for Kubernetes
  • Tilt: Local Kubernetes development environment

Optional development tools (make install_optional_tools):

  • Relay Util: Load testing tool for sending configurable batches of relays concurrently
  • Graphviz: Required for generating profiling & debugging performance
  • Uber Mockgen: Mock interface generator for testing

Protocol Support​

ProtocolStatus (04/2025)Documentation
ShannonBeta & Private MainNetShannon Protocol Guide

Architecture Overview​

This section will be expanded as more technical details are moved from other documentation files.