@consyerge/cli

Command-line interface for inspecting and managing Consyerge schedules and executions.

Installation

pnpm add -D @consyerge/cli

Configuration

The CLI reads directly from the Consyerge SQLite database. Set the database path using the CONSYERGE_DB_PATH environment variable:

export CONSYERGE_DB_PATH=data/consyerge.sqlite

If not set, the CLI defaults to data/consyerge.sqlite.

Available Commands

Status Overview

pnpm exec consyerge status

Displays a summary of schedule and execution counts:

Schedules:
  Active: 3
  Paused: 1
  Completed: 2

Executions:
  Total: 15
  Failed: 1

List Schedules

pnpm exec consyerge schedules list

Displays all schedules in a table format with ID, name, status, and next run time.

Get Schedule Details

pnpm exec consyerge schedules get <id>

Outputs the full schedule as JSON, including trigger configuration, actions, retry policy, and metadata.

Pause a Schedule

pnpm exec consyerge schedules pause <id>

Resume a Schedule

pnpm exec consyerge schedules resume <id>

Delete a Schedule

pnpm exec consyerge schedules delete <id>

Update a Schedule

pnpm exec consyerge schedules update <id> <json-file>

The JSON file contains a partial update. For example, to change the trigger:

{
  "trigger": {
    "type": "interval",
    "everyMs": 120000
  }
}

To remove a retry policy:

{
  "retry": null
}

List Executions

pnpm exec consyerge executions list

Get Execution Details

pnpm exec consyerge executions get <id>

View Execution History for a Schedule

pnpm exec consyerge executions history <scheduleId>

Displays all executions for a specific schedule, including status, retry count, timestamps, and errors.

Examples

# Check overall system status
pnpm exec consyerge status

# List all schedules
pnpm exec consyerge schedules list

# Inspect a specific schedule
pnpm exec consyerge schedules get abc-123-def

# Pause a schedule temporarily
pnpm exec consyerge schedules pause abc-123-def

# Resume the paused schedule
pnpm exec consyerge schedules resume abc-123-def

# Update a schedule's trigger from a JSON file
pnpm exec consyerge schedules update abc-123-def update.json

# View all executions for a schedule
pnpm exec consyerge executions history abc-123-def

Links

• CLI Guide — comprehensive CLI documentation with detailed examples
• Full Documentation