Skip to content

feat(mongodb-runner): add --json output to start and ls - #877

Draft
autarch wants to merge 1 commit into
08-28-feat_mongodb-runner_default_sls_image_tag_from_build_manifestfrom
08-28-feat_mongodb-runner_add_json_output
Draft

feat(mongodb-runner): add --json output to start and ls#877
autarch wants to merge 1 commit into
08-28-feat_mongodb-runner_default_sls_image_tag_from_build_manifestfrom
08-28-feat_mongodb-runner_add_json_output

Conversation

@autarch

@autarch autarch commented Sep 2, 2026

Copy link
Copy Markdown
Collaborator

Description

This adds a --json output option. When this is enabled, the only output the runner prints to stdout is a JSON object containing information about the started cluster. The JSON always contains an id and connectionString key.

This is handy for scripting with the runner, and makes it easy to save the cluster information in a structured way, which is particularly helpful if you want to save multiple clusters.

Open Questions

None.

Checklist


Stack created with GitHub Stacks CLIGive Feedback 💬

@gribnoysup

Copy link
Copy Markdown
Collaborator

I'd maybe suggest to take a look at #626. There's already some interfaces for serialization of these instances that should probably be used instead of building these from scratch right in the method

@autarch

autarch commented Sep 3, 2026

Copy link
Copy Markdown
Collaborator Author

I'd maybe suggest to take a look at #626. There's already some interfaces for serialization of these instances that should probably be used instead of building these from scratch right in the method

@gribnoysup What's the state of #626? It would be good to build on top of that, but it's been open since March. I could fold those changes into this PR, which might be simplest.

@gribnoysup

Copy link
Copy Markdown
Collaborator

@autarch

I could fold those changes into this PR, which might be simplest.

This works I think, this patch Anna opened is practically ready, was just waiting for feedback and got a bit lost over time, so would be good to use it as a starting point here

@autarch
autarch force-pushed the 08-28-feat_mongodb-runner_add_json_output branch from 4fc924b to 47a6565 Compare September 11, 2026 19:27
Copilot AI lite review requested due to automatic review settings September 11, 2026 19:27

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

No unresolved blocking issues were identified.

Pull request overview

Adds --json output for mongodb-runner start and ls, enabling scripting with structured cluster metadata.

Changes:

  • Implements JSON output handling.
  • Adds tests for start and ls.
  • Updates usage and disaggregated-storage documentation.
File summaries
File Summary
packages/mongodb-runner/src/cli.ts Implements JSON output modes.
packages/mongodb-runner/src/cli.spec.ts Tests structured JSON output.
packages/mongodb-runner/README.md Documents the new option and formats.
packages/mongodb-runner/docs/disaggregated-storage.md Documents JSON output for DSC clusters.
Review details
  • Files reviewed: 4/4 changed files
  • Comments generated: 0
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

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