Skip to content

croncommander/cc-spec

Repository files navigation

cc-spec

This repository contains the versioned interface specifications for the CronCommander project. It is private while the next agent transport is being designed.

The specifications defined here describe the stable contracts between CronCommander components, such as job runners, agents, and the central server. These documents are intended to be:

  • Implementation-agnostic
  • Stable within a major version
  • A single source of truth for cross-component behavior

Scope

This repository defines what crosses process or network boundaries.

It intentionally does not define:

  • Internal server architecture
  • Storage schemas
  • Internal credential storage or issuance implementation
  • Retry or transport implementations

Current specifications

  • agent-gateway-http-v2.md — Current HTTPS agent/gateway contract
  • execution-report-v1.md — Canonical format for reporting cron job executions

agent-listener-spec-v1.md is the historical WebSocket contract. There is no v1 compatibility period because CronCommander had no production agent fleet when HTTP v2 replaced it.

Versioning

Breaking changes to a specification require a new major version. Minor, backward-compatible additions may be made within a version.

The repository can be made public again after the HTTP contract is stable and the documents have been reviewed for internal implementation details.

Project

Part of the CronCommander project.

Website: https://croncommander.com

About

Public specifications and interface contracts for the CronCommander project.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors