Skip to content

AGENTS.md

Latest commit

 

History

History
49 lines (32 loc) · 1.99 KB

AGENTS.md

File metadata and controls

49 lines (32 loc) · 1.99 KB
Raw

AGENTS.md — wave-av/cli

Agent contract for this repo. Inherits the org default (https://github.com/wave-av/.github/blob/main/AGENTS.md) and the repo-governance standard.

Build and test

See README.md for setup. Run the repo's lint / typecheck / test before opening a PR, and fix what you broke.

Rules

  • Branch and open a PR; never push to the default branch. All required gates must pass before merge.
  • No secrets in commits — secret-scan is a required gate and will block.
  • Conventional Commit titles; update CHANGELOG.md (Unreleased) for user-facing changes.
  • Match the existing code conventions; keep files focused (~200-500 lines).

Security

Report vulnerabilities via the Security Policy (security@wave.online) — never in a public issue.

CONTENTS

@wave-av/cli — WAVE CLI — manage live streams, productions, and video infrastructure from your terminal. 34 command groups.

Top-level directories: scripts, src, templates.

GUIDELINES

  • Every capability ships its four renderings (API + CLI + SDK + MCP); the API is the authority.
  • No secrets in git — credential values live in Doppler; keys arrive via ${DOPPLER:KEY} refs or dpg.mjs.
  • Public repos carry LICENSE in the same commit as first code.
  • Tests ship with the artifact in the same PR — no test, no ship; a green suite is not a live system.
  • Plans/runbooks live in governance/plans (or this repo's plans/ dir), never scattered.

Machine surface

version: "0.1"
budget_lines: 200
index:
  - family: test-contract
    path: TESTING.md
  - family: permissions-contract
    path: PERMISSIONS.md