Nudge CLI

Command-line interface for the Nudge push notification service.

Installation

cd cli
npm install
npm run build
npm link    # makes `nudge` available globally

Quick Start

# Create an account (or use `nudge login` if you already have one)
nudge signup --url http://localhost:3000

# Create a nudge
nudge nudges create "Server Alerts"

# Send a test webhook
nudge nudges send <slug> --data '{"server": "prod-01", "cpu": 95}'

# View notification history
nudge notifications list <nudge-id>

Commands

| Command | Description | |---------|-------------| | nudge signup | Create a new account | | nudge login | Log in to your account | | nudge logout | Log out | | nudge whoami | Show current user | | nudge config | View/set configuration | | nudge nudges list | List all nudges | | nudge nudges create <name> | Create a nudge | | nudge nudges show <id> | Show nudge details | | nudge nudges update <id> | Update nudge settings | | nudge nudges delete <id> | Delete a nudge | | nudge nudges test <id> | Test with sample payload | | nudge nudges send <slug> | Send webhook payload | | nudge nudges logs <id> | View webhook logs | | nudge nudges gen <id> | AI-generate templates | | nudge devices list <id> | List devices | | nudge devices register <id> | Register a device | | nudge devices remove <id> <deviceId> | Remove a device | | nudge notifications list <id> | List notifications | | nudge notifications show <id> <notifId> | Notification details |

Claude Code Skill

Install the Nudge skill for Claude Code:

# From the cli/ directory
cp -r skill ~/.claude/skills/nudge

Or if using zdev:

zdev skills install nudge --path ./cli/skill

Once installed, Claude Code can manage your Nudge setup through natural language.

Configuration

Config is stored at ~/.nudge/config.json:

{
  "baseUrl": "http://localhost:3000",
  "sessionToken": "..."
}

Set the server URL:

nudge config --url https://api.nudge.app