suggested_commands

Building and Running

  • make path_build — Build the PATH binary locally

  • make path_run — Run PATH as a standalone binary (requires CONFIG_PATH)

  • make path_up — Start local Tilt development environment with dependencies

  • make path_down — Tear down local Tilt development environment

Common build/run targets
make path_build
make path_run
make path_up
make path_down

Testing

  • make test_unit — Run all unit tests (go test ./... -short -count=1)

  • make test_all — Run unit tests plus E2E tests for key services

  • make e2e_test SERVICE_IDS — Run E2E tests for specific Shannon service IDs (e.g., make e2e_test eth,poly)

  • make load_test SERVICE_IDS — Run Shannon load tests

  • make go_lint — Run Go linters (golangci-lint run --timeout 5m --build-tags test)

Common test targets
make test_unit
make test_all
make e2e_test SERVICE_IDS        # e.g., make e2e_test eth,poly
make load_test SERVICE_IDS
make go_lint

Configuration

  • make config_prepare_shannon_e2e — Prepare Shannon E2E configuration

Configuration target
make config_prepare_shannon_e2e

Release and Versioning

  • make release_build_cross — Build binaries for multiple platforms with version info

  • make release_build_local — Build binary for current platform only

  • make release_tag_dev — Tag a new dev release

  • make release_tag_bug_fix — Tag a new bug fix release

  • make release_tag_minor_release — Tag a new minor release

Release targets
make release_build_cross
make release_build_local
make release_tag_dev
make release_tag_bug_fix
make release_tag_minor_release

System Commands (Darwin)

Useful local commands when developing on macOS:

  • git — version control

  • grep — text search (consider rg / ripgrep if available)

  • find — file searching

  • ls — directory listing

  • cd — directory navigation

Typical macOS utilities
git status
grep "pattern" file
find . -name '*.go'
ls -la
cd path/to/dir

Was this helpful?