Skip to content

INSTALL.md

Latest commit

 

History

History
105 lines (79 loc) · 2.17 KB

INSTALL.md

File metadata and controls

105 lines (79 loc) · 2.17 KB

Charon Installation Guide

Quick Start

npx charon-hooks

Runs on port 3000 by default. Open http://localhost:3000 to access the dashboard.

Data Directory

All configuration and data is stored in ~/.charon/:

~/.charon/
├── config/
│   ├── config.yaml      # Server settings
│   └── triggers.yaml    # Trigger definitions
├── sanitizers/          # Custom sanitizer scripts
├── charon.db            # SQLite database
└── charon.pid           # PID file (when running)

Override with CHARON_DATA_DIR environment variable:

CHARON_DATA_DIR=/custom/path npx charon-hooks

Service Commands

npx charon-hooks --service status   # Check if running
npx charon-hooks --service start    # Start in background
npx charon-hooks --service stop     # Stop background process
npx charon-hooks --service install  # Generate system service files

Install as System Service

Generate service files for your OS:

npx charon-hooks --service install

Linux (systemd):

mkdir -p ~/.config/systemd/user
cp ~/.charon/service/charon-hooks.service ~/.config/systemd/user/
systemctl --user daemon-reload
systemctl --user enable charon-hooks
systemctl --user start charon-hooks

macOS (launchd):

cp ~/.charon/service/com.charon.hooks.plist ~/Library/LaunchAgents/
launchctl load ~/Library/LaunchAgents/com.charon.hooks.plist

Configuration

config.yaml - Server settings:

server:
  port: 3000

triggers.yaml - Trigger definitions:

triggers:
  - id: my-webhook
    name: "My Webhook"
    type: webhook
    enabled: true
    sanitizer: passthrough
    template: "Received: {message}"
    egress: console

Development

For local development from source:

git clone https://github.com/NaxYo/charon
cd charon
bun install
bun dev

Development mode (bun dev) uses the current directory for config/data instead of ~/.charon/.

Claude Code Plugin

Install the Charon plugin for Claude Code:

/plugin marketplace add NaxYo/cc-marketplace
/plugin install charon

See charon-plugin for plugin documentation.