Skip to content

chore(docs): document --json flag#258

Merged
comatory merged 2 commits intomainfrom
ondrej/eng-8836-cli-add-json-to-subgraph-check
Mar 10, 2026
Merged

chore(docs): document --json flag#258
comatory merged 2 commits intomainfrom
ondrej/eng-8836-cli-add-json-to-subgraph-check

Conversation

@comatory
Copy link
Copy Markdown
Contributor

@comatory comatory commented Mar 5, 2026

Description

Documents the new --json flag feature: wundergraph/cosmo#2590

Summary by CodeRabbit

  • Documentation
    • Added --json and --out options to the monograph check docs, with examples showing JSON output and writing results to a file for automation.
    • Added --json and --out options to the subgraph check docs, including step-by-step examples and JSON output samples for automated workflows.

Checklist

  • I have validated my changes locally using mintlify dev
  • I have validated my changes are working as expected by looking at the preview deployment
  • All links in my documentation work correctly
  • All images render properly
  • Code examples are tested and formatted correctly
  • If I added new pages, they are included in the navigation (docs.json) (n/a)

@comatory comatory requested review from a team as code owners March 5, 2026 12:09
@comatory comatory requested review from JivusAyrus, StarpTech, asoorm and wilsonrivera and removed request for a team March 5, 2026 12:09
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 5, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 9b9fbcda-0d66-4f3b-b669-f29c23b10b1e

📥 Commits

Reviewing files that changed from the base of the PR and between 6ae26a0 and 925d477.

📒 Files selected for processing (2)
  • docs/cli/monograph/check.mdx
  • docs/cli/subgraph/check.mdx
🚧 Files skipped from review as they are similar to previous changes (2)
  • docs/cli/subgraph/check.mdx
  • docs/cli/monograph/check.mdx

Walkthrough

Adds documentation for two new CLI options, -j/--json and -o/--out [string], to the monograph and subgraph check commands; includes usage examples, sample JSON output blocks, and minor formatting fixes (removal of an extra trailing blank line).

Changes

Cohort / File(s) Summary
CLI check docs
docs/cli/monograph/check.mdx, docs/cli/subgraph/check.mdx
Introduces -j, --json (print results as JSON) and -o, --out [string] (write JSON to a file) options; adds examples showing JSON output and file-writing workflows; adds sample JSON output blocks and small formatting adjustments (removed extra trailing blank line in monograph doc).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'chore(docs): document --json flag' accurately summarizes the primary change in the changeset, which adds documentation for the --json flag across multiple CLI check command pages.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@StarpTech
Copy link
Copy Markdown
Contributor

StarpTech commented Mar 7, 2026

We are pretty much consistent by supporting --json --out Could you extend these for check as well?

https://cosmo-docs.wundergraph.com/cli/namespace/list
https://cosmo-docs.wundergraph.com/cli/federated-graph/list

@comatory
Copy link
Copy Markdown
Contributor Author

@StarpTech I added --out flag as well and it's documented too.

Copy link
Copy Markdown
Contributor

@StarpTech StarpTech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@comatory comatory merged commit 6969ee7 into main Mar 10, 2026
3 checks passed
Noroth pushed a commit that referenced this pull request Mar 20, 2026
* chore(docs): document --json flag

* feat: document --out flag
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants