cluster-cli: Instructions file for Codex

AGENTS.md

This file provides guidance for agents working in this repository.

Build / Lint / Test Commands

# Build
cargo build                        # debug build
cargo build --release              # optimized build (lto, strip, panic=abort)

# Testing
cargo test --verbose               # run all tests
cargo test <test_name>             # run a single test by name (e.g., cargo test test_critical_node_penalty)

# Formatting (CI enforces this)
cargo fmt -- --check               # check formatting
cargo fmt                          # apply formatting

# Linting (warnings are errors in CI)
cargo clippy -- -D warnings       # lint with warnings-as-errors

# Update dependencies
cargo update                       # update to latest compatible versions

Shared Agent Skills

Reusable repository skills live in .agents/skills/. Read the relevant SKILL.md before performing a matching task; release-cluster-cli governs release preparation, tagging, and release-status work.

Documentation

When features, key bindings, CLI flags, or MCP tools change, update the documentation to stay synchronized with the code.

What to update:

• docs/*.md - Markdown documentation files
• docs/index.html - Landing page (self-contained HTML)

How to update: Use the update-docs skill at .agents/skills/update-docs/SKILL.md. This skill:

• Reads the code as source of truth (no invented features)
• Updates all affected documentation files
• Regenerates the landing page with current features
• Verifies every documented key binding, flag, and tool exists in code
• Renders a screenshot for PR inclusion

Hosted documentation: The docs/ folder is published to GitHub Pages at https://sharat.github.io/cluster-cli/: the .github/workflows/pages.yml workflow copies it to the gh-pages branch, which Pages serves, on pushes to main that touch docs/**.

See: .agents/skills/update-docs/SKILL.md for complete documentation update workflow.

Changelog Maintenance