Skip to content

Latest commit

 

History

History
22 lines (14 loc) · 1.44 KB

File metadata and controls

22 lines (14 loc) · 1.44 KB

quantcli/common

Shared contracts and conventions for quantcli export CLIs.

Contents

  • CONTRACT.md — the user-facing surface every *-export-cli adheres to: repo naming, timezone policy, date flags, output formats, auth, the prime subcommand, versioning.
  • CONTRIBUTING.md — branch and commit style, how to propose a contract change, how to add a new export-cli, the compat-test expectation.
  • TRIAGE.md — issue-triage SLA, label scheme, and routing for the four quantcli/* repos.
  • LICENSE — MIT.

Why a repo for this

Three (and counting) export CLIs in this org all share the same shape: take credentials from the environment, accept --since / --until, emit markdown by default and JSON for agents, treat dates as local. Documenting that surface in one place — instead of in each CLI's README — keeps them honestly identical.

A change to the contract is a change every CLI agrees to make. Open a PR here before changing the surface in any individual CLI.

Repos that follow this contract