corvix.cli

Command line interface for Corvix.

Attributes

logger
F

Functions

_parse_bool_value(→ bool)
_resolve_apply_actions_default(→ bool | None)
_apply_actions_callback(→ bool)
_apply_actions_option(→ collections.abc.Callable[[F], F])
main(→ None)	Corvix local GitHub notifications dashboard.
init_config_command(→ None)	Write a starter YAML config.
poll_command(→ None)	Run one poll cycle and persist processed notifications to cache.
watch_command(→ None)	Run periodic poll cycles, suitable for cron-like local daemon behavior.
dashboard_command(→ None)	Render dashboards from the persisted cache file without polling GitHub.
serve_command(→ None)	Run Litestar dashboard website.
poller_health_command(→ None)	Exit 0 when the poller status in PostgreSQL is fresh, else fail.
_build_storage(→ corvix.storage.StorageBackend)	Build the configured storage backend, surfacing config errors to the CLI.
_load_app_config(→ corvix.config.AppConfig)
_resolve_token(→ str)
_build_targets(...)	Construct the server-side notification dispatch targets from config.
_resolve_optional_secret(→ str | None)	Resolve a secret env var (supporting <VAR>_FILE), returning None if unset.
_build_clients(...)
_config_path_from_context(→ pathlib.Path)

Module Contents

corvix.cli.logger

corvix.cli.F

corvix.cli._parse_bool_value(value: str) → bool

corvix.cli._resolve_apply_actions_default() → bool | None

corvix.cli._apply_actions_callback(ctx: click.Context, param: click.Parameter, value: bool) → bool

corvix.cli._apply_actions_option() → collections.abc.Callable[[F], F]

corvix.cli.main(ctx: click.Context, config_path: pathlib.Path) → None

Corvix local GitHub notifications dashboard.

corvix.cli.init_config_command(path: pathlib.Path, force: bool) → None

Write a starter YAML config.

corvix.cli.poll_command(ctx: click.Context, apply_actions: bool) → None

Run one poll cycle and persist processed notifications to cache.

corvix.cli.watch_command(ctx: click.Context, apply_actions: bool, iterations: int | None) → None

Run periodic poll cycles, suitable for cron-like local daemon behavior.

corvix.cli.dashboard_command(ctx: click.Context, dashboard_name: str | None) → None

Render dashboards from the persisted cache file without polling GitHub.

corvix.cli.serve_command(ctx: click.Context, host: str, port: int, reload: bool) → None

Run Litestar dashboard website.

corvix.cli.poller_health_command(ctx: click.Context) → None

Exit 0 when the poller status in PostgreSQL is fresh, else fail.

Intended for container healthchecks: it reads the poller status the watch loop writes to PostgreSQL and verifies a successful poll happened recently.

corvix.cli._build_storage(app_config: corvix.config.AppConfig) → corvix.storage.StorageBackend

Build the configured storage backend, surfacing config errors to the CLI.

corvix.cli._load_app_config(config_path: pathlib.Path) → corvix.config.AppConfig

corvix.cli._resolve_token(token_env: str) → str

corvix.cli._build_targets(app_config: corvix.config.AppConfig) → list[corvix.notifications.targets.base.NotificationTarget]

Construct the server-side notification dispatch targets from config.

Only server-side delivery channels are built here. Browser-tab and Web Push delivery are handled client-side by the web UI (from the browser_tab / web_push config echoed in the snapshot), so they are intentionally not represented as Python targets.

A target whose secret env var is missing is skipped with a warning rather than silently doing nothing. When notification dispatch is enabled but no server-side target ends up configured, a note is logged so the “enabled but nothing happens” case is not silent.

corvix.cli._resolve_optional_secret(env_var: str) → str | None

Resolve a secret env var (supporting <VAR>_FILE), returning None if unset.

corvix.cli._build_clients(accounts: list[corvix.config.GitHubAccountConfig], polling: corvix.config.PollingConfig) → tuple[corvix.services.NotificationsClient, Ellipsis]

corvix.cli._config_path_from_context(ctx: click.Context) → pathlib.Path