clog - Coding Agent Event Publisher for NATS

A lightweight Go binary for publishing task progress, questions, and events from CLI-based coding agents to NATS. This tool enables real-time monitoring and integration of AI-assisted development workflows with your NATS-based systems.

Works with any coding agent that has access to CLI tools - Claude Code, Codex, Aider, Cursor, or custom automation scripts.

Everyone: But Dave, it's just an opinionated wrapper around NATS!

Dave: Yes. And it works.

Perfect for:

🤖 Tracking automation workflows from any CLI-based coding agent
📊 Real-time monitoring of AI-assisted development
🔔 Event-driven notifications from agent sessions
📈 Building analytics around coding agent usage
🔗 Integrating agent workflows with existing NATS infrastructure
🔄 Future: Bidirectional interactivity for important signals and workflow control

Features

✅ 5 Authentication Methods: None, Username/Password, Token, NKey, or Decentralized (JWT + Seed)
✅ Zero Configuration: Works out of the box with local NATS server
✅ Environment Variable Support: Override credentials at runtime
✅ Secure by Default: Credentials baked into binary, never stored in source
✅ Comprehensive Event Types: Tasks, questions, progress, and sessions
✅ Claude Code Integration: Easy hook setup for automatic tracking
✅ Well-Tested: Comprehensive test suite with multiple authentication scenarios

History & Background

clog was originally created as a specialized tool for Claude Code, Anthropic's CLI-based coding assistant. The initial goal was simple: publish task progress and questions from Claude to NATS for real-time monitoring and event-driven workflows.

However, the architecture proved to be universally applicable. Since clog is just a CLI binary, any coding agent with access to CLI tools can use it - whether that's Claude Code, Aider, Cursor, GitHub Copilot CLI, or custom automation scripts. The name "clog" has stuck (originally "Claude Log"), but the tool has evolved beyond its original scope.

Current capabilities:

Publish events (tasks, questions, progress, sessions) from any CLI-based agent
Real-time monitoring via NATS subjects
Event-driven integrations and notifications
Analytics and workflow tracking

Future aspirations:

Bidirectional interactivity: Not just publishing events, but receiving important signals back
Workflow control: Allow external systems to influence or guide agent behavior
Smart notifications: Filter and prioritize which events deserve immediate attention
Agent coordination: Enable multiple agents to work together through shared event streams

The vision is to create a robust communication layer between coding agents and the broader development ecosystem, with NATS serving as the messaging backbone.

License

Licensed under the Apache License, Version 2.0. See LICENSE for details.

Quick Start with NATS

If you don't have a NATS server running, here's how to quickly set one up:

1. Install NATS Server

macOS (Homebrew):

brew install nats-server

Linux:

# Download the latest release
curl -L https://github.com/nats-io/nats-server/releases/latest/download/nats-server-linux-amd64.zip -o nats-server.zip
unzip nats-server.zip
sudo mv nats-server /usr/local/bin/

Or use Docker:

docker run -d --name nats -p 4222:4222 nats:latest

2. Start NATS Server

# Simple start (no authentication)
nats-server

# Or with a custom port
nats-server -p 4222

You should see output like:

[1] 2025/10/09 18:00:00.000000 [INF] Starting nats-server
[1] 2025/10/09 18:00:00.000000 [INF]   Version:  2.10.0
[1] 2025/10/09 18:00:00.000000 [INF] Listening for client connections on 0.0.0.0:4222

3. Build and Use clog

# Clone and build
git clone https://github.com/davedotdev/clog.git
cd clog
go build -o clog ./cmd/main.go

# Send a test message
./clog -type=task -state=in_progress -message="Hello from clog!" -session="test-$(date +%s)"

4. Monitor NATS Messages (Optional)

Install the NATS CLI to see your messages in real-time:

# Install NATS CLI
brew install nats-io/nats-tools/nats  # macOS
# or download from: https://github.com/nats-io/natscli/releases

# Subscribe to all Claude events
nats sub "claude.>"

# Or subscribe to specific subjects
nats sub "claude.tasks.*"
nats sub "claude.questions.*"

Now when you use clog, you'll see the messages appear in your NATS subscriber!

5. Integrate with Claude Code (Global Setup)

Set up Claude Code to automatically use clog across all your projects:

# Run the setup command
make setup-claude

This will:

✅ Create ~/.claude/CLAUDE.md with global instructions for Claude Code
✅ Configure ~/.claude/settings.json to allow clog commands system-wide
✅ Make Claude Code aware of clog in every conversation

What this does:

Claude Code will know about clog in all your projects, not just this one
Claude will send NATS notifications before asking you questions
No manual approval needed for clog commands
Works globally since clog is installed in your system PATH

Now when Claude Code needs to ask you a question in any project, it will automatically send a NATS notification first!

Installation

Prerequisites

Go 1.21 or later
NATS server access with JWT/Seed credentials
(Optional) Make for simplified building

Building from Source

Clone the repository:

git clone https://github.com/davedotdev/clog.git
cd clog

Install dependencies:
```
go mod tidy
```
Build with configuration (recommended):
```
make build
```
The build process will interactively prompt you for:
- NATS URL (default: nats://localhost:4222)
- Authentication type:
  1. None - No authentication
  2. Username/Password - Traditional username and password
  3. Token - Token-based authentication
  4. NKey - NKey authentication
  5. Decentralized - Decentralized authentication (JWT + Seed)
Your configuration will be baked into the binary and then removed from the source code automatically.
Set up Claude Code integration (optional, global):
```
make setup-claude
```
This creates global configuration files in ~/.claude/ so Claude Code can automatically use clog across all your projects to send notifications when asking questions or tracking tasks.
Install to system PATH:
```
make install
```
This copies the binary to /usr/local/bin/clog (requires sudo).

Alternative: Manual Build

If you prefer to manually edit credentials:

# Edit cmd/main.go and replace placeholders with your credentials
# Then build manually
go build -o clog ./cmd/main.go

# Copy to your PATH
sudo cp clog /usr/local/bin/clog

Adding to PATH (for Claude Code)

For Claude Code to use clog in hooks and scripts, ensure it's in your PATH:

Option 1: System-wide installation (recommended)
```
make install
```

Option 2: User bin directory

mkdir -p ~/bin
cp clog ~/bin/
echo 'export PATH="$HOME/bin:$PATH"' >> ~/.bashrc  # or ~/.zshrc
source ~/.bashrc  # or ~/.zshrc

Verify installation:
```
which clog
clog -h
```

Configuration

Baked-in Configuration (Default)

The recommended approach is to use make build, which:

Prompts for NATS URL and authentication type interactively
Bakes configuration into the binary at compile time
Keeps the source code clean with template placeholders

This ensures credentials are never committed to version control.

Environment Variables (Runtime Override)

Override baked-in configuration at runtime using environment variables. The priority order is:

Credentials file (highest priority)

export NATS_URL="nats://localhost:4222"
export NATS_CREDS="/path/to/creds.file"

Username/Password authentication

export NATS_URL="nats://localhost:4222"
export NATS_USERNAME="myuser"
export NATS_PASSWORD="mypassword"

Token authentication

export NATS_URL="nats://localhost:4222"
export NATS_TOKEN="mytoken"

NKey authentication

export NATS_URL="nats://localhost:4222"
export NATS_NKEY="SUABC..."

Decentralized authentication (JWT + Seed)

export NATS_URL="nats://localhost:4222"
export NATS_JWT="eyJ0eXAiOiJKV1Q..."
export NATS_SEED="SUAK7SG5BVF..."

Baked-in credentials (lowest priority - from build time)

Using with Claude Code (Global & Project-Specific)

Claude Code supports both global configuration (applied to all projects) and project-specific configuration (for individual projects with custom clog setups). You can use one or both depending on your needs.

Automatic Setup (Recommended - Global)

Run the setup command to configure Claude Code to automatically use clog across all your projects:

make setup-claude

This will:

Create ~/.claude/CLAUDE.md - Global memory file that instructs Claude Code when and how to use clog
Create or update ~/.claude/settings.json - Global permissions file that allows clog commands without approval
Ensure seamless integration with Claude Code in every project

What Claude Code will do automatically:

Know about clog in all your projects (not just this one)
Send NATS notifications before asking you questions
Track task progress when working on multi-step tasks
No manual intervention required
Works anywhere since clog is in your system PATH

Project-Specific Setup (For Multiple clog Instances)

If you're working on multiple projects with different clog configurations (different NATS servers, subjects, or reminders), you can set up project-specific configuration alongside the global one.

Why use project-specific setup?

Different projects connect to different NATS servers
Different teams/projects want different custom reminders
Testing new clog features without affecting global setup
Project has its own clog binary with specific configuration

Setup steps:

Build project-specific clog binary:

# In your project directory
cd /path/to/your/project
git clone https://github.com/davedotdev/clog.git .clog-build
cd .clog-build
make build  # Configure with project-specific NATS URL and reminders
cp clog ../clog-project  # Copy to project root with unique name
cd ..
rm -rf .clog-build

Create project-specific Claude configuration:
```
mkdir -p .claude
```

Create .claude/settings.local.json:

{
  "permissions": {
    "allow": [
      "Bash(./clog-project:*)"
    ]
  }
}

Create .claude/CLAUDE.md (optional):

# Project-Specific clog Configuration

This project uses a custom clog binary at `./clog-project` configured for:
- NATS Server: nats://project.example.com:4222
- Custom reminders specific to this project

Use `./clog-project` instead of `clog` in this project.

How it works:

Global config (~/.claude/CLAUDE.md): Applied to all projects
Project config (./.claude/CLAUDE.md): Supplements or overrides for this project
Global permissions (~/.claude/settings.json): System-wide clog permissions
Project permissions (./.claude/settings.local.json): Additional project-specific permissions

Claude Code merges both global and project configurations, so you get the best of both worlds!

Manual Integration

If you prefer manual setup, you can also use clog in custom hooks or scripts.

Example usage in scripts:

#!/bin/bash
SESSION_ID="my-session-$(date +%s)"

# Start session
clog -type=session -message="Starting deployment process" -session="$SESSION_ID"

# Log task progress
clog -type=task -state=in_progress -message="Building application" -task-num="1/5" -session="$SESSION_ID"

# Task completed
clog -type=task -state=completed -message="Build successful" -task-num="1/5" -session="$SESSION_ID"

# Ask question
clog -type=question -state=blocked -message="Deploy to staging or production?" -session="$SESSION_ID"

Usage

See help:

./clog -h

Examples:

# Task started
./clog -type=task -state=in_progress -message="Adding VAT breakdown" -task-num="3/15" -session="nye-api"

# Task completed
./clog -type=task -state=completed -message="VAT breakdown added" -task-num="3/15" -session="nye-api"

# Question
./clog -type=question -state=blocked -message="Should VAT be inclusive?" -session="nye-api"

# Progress
./clog -type=progress -message="50% complete" -session="nye-api"

NATS Subjects

The tool publishes to these hardwired subjects based on type and state:

claude.tasks.started - Task in progress
claude.tasks.completed - Task completed
claude.tasks.blocked - Task blocked
claude.questions.asked - Question asked
claude.questions.waiting - Waiting for answer
claude.progress.update - Progress update
claude.session.started - Session started
claude.session.completed - Session completed

Message Format

Messages are published as JSON:

{
  "event": "claude.tasks.completed",
  "timestamp": "2025-10-09T14:30:00Z",
  "session_id": "nye-api-1696854321-a4f9",
  "message": "VAT breakdown added",
  "state": "completed",
  "task_num": "3/15"
}

Exit Codes

0 - Success
1 - Invalid arguments
2 - NATS connection failed

Development

Available Make Targets

make build         # Build clog with interactive configuration
make setup-claude  # Configure Claude Code integration
make install       # Install clog to /usr/local/bin
make unittest      # Run unit tests
make test          # Build and run help output
make clean         # Clean build artifacts
make tidy          # Run go mod tidy

Running Tests

# Run unit tests
make unittest

# Run all tests with coverage
go test -v -cover ./cmd/

Building for Development

# Build without credential prompts (uses placeholders)
go build -o clog ./cmd/main.go

# Run with environment variables
export NATS_URL="nats://localhost:4222"
export NATS_CREDS="/path/to/test.creds"
./clog -type=task -message="Test" -session="dev"

Contributing

See CONTRIBUTING.md for development guidelines and best practices.

Security Notes

Configuration and credentials are baked into the binary at build time
Source code uses template placeholders to prevent accidental credential commits
.gitignore is configured to exclude binaries and credential files
Never commit actual NATS credentials to version control
Review the build process in Makefile to understand credential handling
Supports 5 authentication methods: none, username/password, token, NKey, and decentralized (JWT + Seed)

Contributors

We appreciate all contributions to clog! See CONTRIBUTORS.md for the full list of contributors and information on how to contribute to the project.

Key Contributors:

davedotdev - Original creator and maintainer

Want to contribute? Check out our Contributing Guidelines to get started!

Name		Name	Last commit message	Last commit date
Latest commit History 12 Commits
cmd		cmd
.gitignore		.gitignore
CHANGELOG.md		CHANGELOG.md
CONTRIBUTING.md		CONTRIBUTING.md
CONTRIBUTORS.md		CONTRIBUTORS.md
LICENSE		LICENSE
Makefile		Makefile
NATS_Helper.md		NATS_Helper.md
README.md		README.md
REMINDERS.md		REMINDERS.md
clog.png		clog.png
design.md		design.md
go.mod		go.mod
go.sum		go.sum

License

davedotdev/clog

Folders and files

Latest commit

History

Repository files navigation

clog - Coding Agent Event Publisher for NATS

Features

History & Background

Table of Contents

License

Quick Start with NATS

1. Install NATS Server

2. Start NATS Server

3. Build and Use clog

4. Monitor NATS Messages (Optional)

5. Integrate with Claude Code (Global Setup)

Installation

Prerequisites

Building from Source

Alternative: Manual Build

Adding to PATH (for Claude Code)

Configuration

Baked-in Configuration (Default)

Environment Variables (Runtime Override)

Using with Claude Code (Global & Project-Specific)

Automatic Setup (Recommended - Global)

Project-Specific Setup (For Multiple clog Instances)

Manual Integration

Usage

NATS Subjects

Message Format

Exit Codes

Development

Available Make Targets

Running Tests

Building for Development

Contributing

Security Notes

Contributors

About

Topics

Resources

License

Contributing

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages