Skip to content

enximi/codex-notifier

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

codex-notifier

中文说明

A small Windows notifier that turns Codex events or manual messages into desktop alerts.

It currently does two things:

  • Sends Windows Toast notifications
  • Runs one default full-screen flash effect when a notification is sent

The goal of this project is simple: stay lightweight, direct, and easy to integrate into a local development setup.

Platform

  • Windows only

Features

  • Send manual notifications
  • Accept Codex JSON payloads
  • Convert agent-turn-complete events into readable notification titles and messages
  • Always run the default flash effect when sending a notification

CLI

Show help:

codex-notifier --help

Send a manual notification:

codex-notifier manual "Build finished" "The release build completed successfully."

Handle a Codex payload:

codex-notifier codex --json "{...}"

If no subcommand is provided, the program sends a default test notification:

codex-notifier

Codex Integration

Build the release binary first:

cargo build --release

Then point notify in ~/.codex/config.toml to the release binary in this project, for example:

notify = [
  "D:\\path\\to\\codex-notifier\\target\\release\\codex-notifier.exe",
  "codex",
  "--json"
]

Codex passes the payload as the final argument to --json.

Development

Run locally:

cargo run -- manual "Test" "Hello from codex-notifier"

Format check:

cargo fmt -- --check

Lint:

cargo clippy --all-targets --all-features -- -D warnings

Tests:

cargo test

Build release:

cargo build --release

Implementation Notes

  • CLI parsing uses clap
  • Codex payload parsing uses serde / serde_json
  • Toast notifications use winrt-notification
  • Full-screen flash uses screen-flash = "0.1.1"

Project Layout

src/
  app.rs            # Main application flow
  cli.rs            # Command-line argument definitions
  codex.rs          # Codex payload -> NotificationContent
  lib.rs            # Library entry point and exports
  main.rs           # Binary entry point
  notification.rs   # Windows Toast notification sending

License

Licensed under either of the following, at your option:

  • MIT License
  • Apache License, Version 2.0

About

A small Windows notifier for Codex events and manual messages.

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages