Skip to content

Commit

Permalink
docs: Update CLI flags documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
samcm committed Jan 16, 2025
1 parent bdb5ddf commit e787e42
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,37 @@ go run ./cmd/sentry/main.go --config /path/to/.contributoor/config.yaml --debug
The `config.yaml` would have been generated for you by the installer.
</details>

<details>
<summary>Available CLI Flags</summary>

All configuration options can be overridden via CLI flags:

```bash
--config string # Config file path
--debug # Enable debug mode
--network string # Ethereum network name (mainnet, sepolia, holesky)
--beacon-node-address string # Address of the beacon node API (e.g. http://localhost:5052)
--metrics-address string # Address of the metrics server (e.g. :9091)
--log-level string # Log level (debug, info, warn, error)
--username string # Username for the output server
--password string # Password for the output server
--output-server-address string # Address of the output server (e.g. xatu.primary.production.platform.ethpandaops.io:443)
--output-server-tls string # Enable TLS for the output server (true/false)
--contributoor-directory string # Directory where contributoor stores configuration and data
```

Example with multiple flags:
```bash
go run ./cmd/sentry/main.go \
--config ./config.yaml \
--debug true \
--network sepolia \
--beacon-node-address http://localhost:5052 \
--metrics-address localhost:9091 \
--log-level debug
```
</details>

<details>
<summary>Code Generation</summary>

Expand Down

0 comments on commit e787e42

Please sign in to comment.