Skip to content

docs: gaze multi-language support — external analyzer protocol and new CLI flags #227

Description

@yvonnedevlinrh

Context

PR unbound-force/gaze#178 adds a JSON-RPC 2.0 external analyzer protocol enabling multi-language support in Gaze.

What changed

  • New --analyzer <binary> and --language <lang> CLI flags on gaze crap, gaze quality, and gaze report
  • New analyzers section in .gaze.yaml for config-based analyzer discovery
  • Three-tier analyzer discovery: CLI flag → .gaze.yaml → PATH convention (gaze-analyzer-<lang>)
  • New docs/protocol.md in-repo — full JSON-RPC protocol specification for external analyzer authors
  • Gaze is no longer Go-only in principle

What needs updating

  • Add a "Multi-language support" section covering the external analyzer concept
  • Document the two new CLI flags (--analyzer, --language) in the CLI reference table
  • Document the .gaze.yaml analyzers: configuration block
  • Document the three-tier analyzer discovery chain
  • Link to or surface the in-repo docs/protocol.md for analyzer authors

Affected pages

  • content/docs/projects/gaze.md — CLI flags table (lines ~145–175), architecture section
  • Any getting-started guide for Gaze

Metadata

Metadata

Labels

docsDocumentation updates needednext-releaseTargeted for inclusion in next release but can be deferred if needed

Type

No type

Projects

Status
In Progress 📋

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions