Skip to content

docs: document vibe-check analyze CLI (v0.1.0) #275

Description

@jflowers

What Changed

Document the newly released vibe-check analyze CLI (v0.1.0) on the public
website. vibe-check v0.1.0 is the first user-facing release: a Go-native
analyze command that computes package-level Martin coupling metrics and emits
JSON.

Content To Add

  • Install: go install github.com/zero-dot-force/vibe-check/cmd/vibe-check@v0.1.0
  • Usage: vibe-check analyze [path] (defaults to .); JSON report to stdout.
  • Flags:
    • --max-instability (float, [0.0, 1.0])
    • --max-distance (float, [0.0, 1.0])
    • --max-lcom (int, >= 1)
    • --no-circular-deps (bool)
    • --timeout (duration; no default)
    • --version
  • Exit codes: 0 success, 1 threshold violation, 2 tool error.
  • Output: JSON schemaVersion 1.1 with an optional extensions object
    (e.g. go.interfaceWidth, go.interfaceProximity); link to the schema at
    metrics/modulegraph.schema.json.
  • Metrics explained: Afferent (Ca) and Efferent (Ce) coupling, Instability,
    Abstractness, Distance from the main sequence, LCOM4 cohesion, and circular
    dependency detection.

Source Of Truth

Why It Matters

The constitution's Website Documentation Sync obligation requires
user-facing behavior shipped in a release to be reflected on the public site.
This is vibe-check's first user-facing CLI release.

References

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions