Skip to main content

Getting Started (< 5 min)

PATH API & Toolkit Harness

Grove logo

Static Badge GitHub Actions Workflow Status GitHub last commit GitHub go.mod Go version GitHub Release GitHub Downloads (all assets, all releases) GitHub Issues or Pull Requests GitHub Issues or Pull Requests GitHub Issues or Pull Requests

1. Clone the repository​

git clone https://github.com/buildwithgrove/path.git
cd ./path

2. Install all dependencies​

Required tools:

make install_tools

Optional but highly recommended tools:

make install_tools_optional
Details on Installed Tools

Tools installed by make install_tools:

  • pocketd CLI: CLI for interacting with Pocket Network's Shannon protocol
  • Docker: Container runtime

Optional development tools (make install_tools_optional):

  • Websocket Load Test: Websocket load testing tool
  • 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

3. Configure your PATH Gateway for Pocket Network​

Pocket Network Cheat Sheet - Configure PATH for the Shannon protocol