docs: add --output json flag documentation for CLI commands #161
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Document JSON output support for CLI commands: - Add JSON Output section to main CLI reference page - Document --output json flag for deploy, invoke, app commands - Document --output json flag for browsers, browser-pools, profiles - Document --output json flag for extensions, proxies - Add browser-pools and profiles CLI sections Related to kernel/cli#67
![tembo[bot]](https://avatars.githubusercontent.com/in/1223475?s=60&v=4){kind=small}
reference/cli/apps.mdx
Outdated
| | `--force` | Overwrite an existing version with the same label. | | ||
| | `--env <KEY=VALUE>`, `-e` | Set environment variables (repeatable). | | ||
| | `--env-file <file>` | Load environment variables from a file (repeatable). | | ||
| | `--output json`, `-o` | Output JSONL (one JSON object per line for each deployment event). | |
Contributor
There was a problem hiding this comment.
Minor: in these flag tables, -o likely still needs the json argument (consistent with the examples in reference/cli.mdx). Might be clearer to document as -o json (same for the other --output json rows in this PR).
Suggested change
| | `--output json`, `-o` | Output JSONL (one JSON object per line for each deployment event). | | |
| | `--output json`, `-o json` | Output JSONL (one JSON object per line for each deployment event). | |
Sayan-
reviewed
Jan 9, 2026
| |------|-------------| | ||
| | `--yes`, `-y` | Skip confirmation. | | ||
|
|
||
| ## Browser pools |
Contributor
There was a problem hiding this comment.
could cross link to /browsers/pools page here
Sayan-
reviewed
Jan 9, 2026
| ### `kernel browser-pools flush <id-or-name>` | ||
| Destroy all idle browsers in the pool. | ||
|
|
||
| ## Profiles |
Contributor
There was a problem hiding this comment.
could cross link to /browsers/profiles page here
Sayan-
approved these changes
Jan 9, 2026
- Add cross-links to /browsers/pools and /browsers/profiles pages - Fix flag documentation: use `-o json` instead of just `-o` for consistency
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
-o jsonusage--output jsonflag for all supported commands in apps.mdx and browsers.mdxThis documents the JSON output feature being added in kernel/cli#67.
Documentation added for:
Apps (reference/cli/apps.mdx):
kernel deploy- JSONL streaming outputkernel deploy history- JSON arraykernel invoke- JSONL streaming outputkernel app list- JSON arraykernel app history- JSON arrayBrowsers (reference/cli/browsers.mdx):
kernel browsers list/create/view/get- JSON outputkernel browsers replays list/start- JSON outputkernel browsers process exec/spawn- JSON outputkernel browsers fs file-info/list-files- JSON outputkernel extensions list/upload- JSON outputkernel proxies list/get/create- JSON outputkernel browser-pools list/create/get/update/acquire- JSON outputkernel profiles list/get/create- JSON outputTest plan
Note
Introduces machine-readable output docs and expands CLI coverage.
reference/cli.mdxwith examples for-o jsonand JSONL streaming--output jsonfor key commands in Apps (deploy/invokeJSONL,deploy history,app list,app historyJSON arrays)--output jsonforbrowsers list/create/view/get, replays (list/start), process (exec/spawn), and filesystem (file-info/list-files); also for extensions and proxiesWritten by Cursor Bugbot for commit dd12f8f. This will update automatically on new commits. Configure here.