Documentation

CLI & Worker Configuration

Configure the CLI and Worker SDK for Cloud or OSS.

This section covers the configuration required for the CLI and Worker SDK.

CLI configuration

Set the endpoint for Cloud or OSS and authenticate with an API key.

githook --endpoint https://api.your-domain.com providers list

Configure OAuth2 in the CLI config so it can fetch tokens automatically.

Worker SDK configuration

Workers can read the same config.yaml as the server, but Cloud workers usually only need the endpoint and auth settings. They resolve driver configuration from the API, not from local storage.

endpoint: https://api.your-domain.com

auth:
  oauth2:
    enabled: true
    issuer: https://auth.your-domain.com
    audience: githook-api
    client_id: your-client-id
    client_secret: your-client-secret
    scopes: [githook.read]

If you prefer environment variables, set GITHOOK_API_BASE_URL and GITHOOK_CONFIG_PATH instead of endpoint.

Cloud workers call the control plane to validate topics, resolve installations, and update event log status. OSS workers can continue to use local driver configuration.