capture

(β˜… 297)

An open source hardware monitoring agent for Checkmate

  • .air.toml
  • .gitignore
  • .golangci.yml
  • .goreleaser.yml
  • CHANGELOG.md
  • CONTRIBUTING.md
  • Dockerfile
  • go.mod
  • go.sum
  • Justfile
  • LICENSE
  • openapi.yml
  • README.md
  • schemathesis.toml
  • SECURITY.md

# Installation Guide

1. Get the code
git clone https://github.com/bluewave-labs/capture

Downloads the entire project code from GitHub to your computer.

cd capture

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Go Go is required to use go install.
go install github.com/bluewave-labs/capture/cmd/capture@latest

Downloads and installs the specified version directly β€” no need to clone the repo yourself.

curl -fsSL https://raw.githubusercontent.com/bluewave-labs/capture/main/deployment/linux/install.sh | sudo bash

Type this command into your terminal and run it.

curl -fsSL https://raw.githubusercontent.com/bluewave-labs/capture/main/deployment/macos/install.sh | sudo bash

Type this command into your terminal and run it.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker run -d \

Runs the built image as an actual container.

docker buildx build -t capture .

Builds a runnable image based on the Dockerfile.

docker run -d -v /etc/os-release:/etc/os-release:ro -p 59232:59232 -e API_SECRET=your-secret-key capture

Runs the built image as an actual container.

docker compose -f caddy.compose.yml up -d

Runs the command against the services defined in the compose file.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Go

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
go install github.com/bluewave-labs/capture/cmd/capture@latest

Downloads and installs the specified version directly β€” no need to clone the repo yourself.

just build # or: go build -o dist/capture ./cmd/capture/

Compiles the Go program into an executable.

βœ… If the build finishes without errors, it worked. If you used go run ., check the terminal output.

Pulled directly from this repo's README.

// repository documentation