contributoor-installer

This repository contains the installer for the contributoor service, which collects data from Ethereum consensus clients.

Getting Started

curl -O https://raw.githubusercontent.com/ethpandaops/contributoor-installer/refs/heads/master/install.sh && chmod +x install.sh && ./install.sh

If you would prefer to check the installation script before running it, you may download and run it manually.

Post-Installation

Note: you may need to start a new shell session before you can run the contributoor command.

After installation, Contributoor can be managed using these commands:

contributoor start    # Start the service
contributoor stop     # Stop the service
contributoor status   # Check service status
contributoor restart  # Restart the service
contributoor config   # View/edit configuration
contributoor update   # Update to latest version

Development

Go Tests

Execute the full test suite:

go test ./...

Run short tests only:

go test -test.short ./...

Run with coverage:

go test -failfast -cover -coverpkg=./... -coverprofile=coverage.out ./... && go tool cover -html=coverage.out

Shell Tests

Requires bats:

bats *.bats

For test coverage (requires kcov):

kcov --bash-parser="$(which bash)" --include-pattern=install.sh /path/to/coverage/output bats --tap install.bats

Contributing

Contributoor is part of EthPandaOps' suite of tools for Ethereum network operations. Contributions are welcome! Please check our GitHub repository for more information.