clockwork-cli

Monitor Clockwork logs for the current project

$ clockwork-cli

$ clockwork-cli [path/to/directory]

$ clockwork-cli [path/to/directory1 path/to/directory2 ...]

clockwork command [options]

run
    Immediately executes a specific task by its ID, bypassing its regular schedule.

deploy
    Deploys or synchronizes tasks defined in a local configuration file (e.g., clockwork.json or clockwork.yaml) with the Clockwork service.

trigger
    Triggers a custom event in Clockwork, which can be used to initiate event-driven tasks.

logs []
    Displays recent execution logs for all tasks or for a specific task if a task ID is provided.

status []
    Shows the current status of all managed tasks or a specific task if a task ID is provided.

version
    Displays the installed version of the Clockwork CLI tool.

help []
    Shows general help information for the CLI or detailed help for a specific command.

clockwork-cli is the official command-line interface for the Clockwork cloud-based task runner. It allows users to interact with their Clockwork account and managed tasks directly from the terminal. This tool simplifies the deployment, management, and monitoring of scheduled jobs and cron tasks without direct server access.

It integrates with various CI/CD pipelines and provides functionalities for running tasks on demand, triggering deployments, viewing logs, and checking task statuses. clockwork-cli is particularly useful for developers and system administrators working with web applications that rely on external scheduling services, abstracting away the complexities of server-side cron configurations.

Requires an active Clockwork account and a valid API key for most operations.
Primarily designed for managing cloud-based scheduled tasks, not local system cron jobs.
Requires internet connectivity to communicate with the Clockwork service.
Not a standard Linux distribution utility; it needs to be installed separately.

Tasks managed by clockwork-cli are typically defined in a declarative configuration file (e.g., clockwork.json or clockwork.yaml). The deploy command reads this file to synchronize task definitions with the Clockwork service, promoting an 'infrastructure-as-code' approach for task scheduling.

Unlike traditional cron, clockwork-cli facilitates remote task execution and centralized monitoring. Users can trigger tasks or view logs from any machine with the CLI installed and configured, without needing direct SSH access to the server where tasks are defined to run.

clockwork-cli was developed by Clockwork.io as a crucial component of its cloud-based task scheduling platform. Its development has focused on providing a robust and convenient command-line interface for users to manage their scheduled jobs programmatically. It has evolved alongside the Clockwork service itself, aiming to simplify task deployment, monitoring, and integration into modern CI/CD workflows, reducing the reliance on direct server-side cron configurations.

cron(8), at(1), systemctl(1)