Installation

The surfpool CLI is available for installation via Homebrew, Snapcraft, or through a manual build.

Homebrew (macOs)

To install surfpool on a macOS system using Homebrew, open a terminal and run:

brew tap txtx/taps
brew install txtx/taps/surfpool

Updating surfpool for Homebrew users

brew tap txtx/taps
brew reinstall surfpool

Note: there have been errors updating the Snap Store to the latest version While this is being resolved, Linux users should install from source

Platform-specific binaries are generated for each release. See the releases page to download a release.

To compile the Surfpool binary from source, clone the surfpool repository.

git clone https://github.com/txtx/surfpool.git

Navigate to the new directory.

cd surfpool

Then, compile the binary. This command will compile the binary and store it in ~/.cargo/bin/surfpool.

cargo surfpool-install

Verify installation:

surfpool -V

Finally, make sure that the surfpool binary is available on your PATH. This process will differ depending on your operating system.