-
Notifications
You must be signed in to change notification settings - Fork 3
docs: add --output json flag documentation for CLI commands #161
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,6 +9,10 @@ title: "Browsers" | |
| ### `kernel browsers list` | ||
| List all browser sessions. | ||
|
|
||
| | Flag | Description | | ||
| |------|-------------| | ||
| | `--output json`, `-o json` | Output raw JSON array. | | ||
|
|
||
| ### `kernel browsers create` | ||
| Create a new browser session. | ||
|
|
||
|
|
@@ -17,6 +21,7 @@ Create a new browser session. | |
| | `--stealth` | Enable stealth mode to reduce automation fingerprints. | | ||
| | `--headless` | Launch without GUI/VNC access. | | ||
| | `--kiosk` | Launch in Chrome kiosk mode. | | ||
| | `--output json`, `-o json` | Output raw JSON object. | | ||
|
|
||
| ### `kernel browsers delete <session-id>` | ||
| Delete a browser session. Use `-y` to skip confirmation. | ||
|
|
@@ -28,6 +33,17 @@ Delete a browser session. Use `-y` to skip confirmation. | |
| ### `kernel browsers view <session-id>` | ||
| Return a live view URL for remote monitoring and control. | ||
|
|
||
| | Flag | Description | | ||
| |------|-------------| | ||
| | `--output json`, `-o json` | Output JSON with `liveViewUrl` field. | | ||
|
|
||
| ### `kernel browsers get <session-id>` | ||
| Get detailed information about a browser session. | ||
|
|
||
| | Flag | Description | | ||
| |------|-------------| | ||
| | `--output json`, `-o json` | Output raw JSON object. | | ||
|
|
||
| ## Browser logs | ||
|
|
||
| ### `kernel browsers logs stream <session-id>` | ||
|
|
@@ -47,13 +63,18 @@ Stream browser logs from the supervisor or a file path. | |
| ### `kernel browsers replays list <session-id>` | ||
| List replay recordings for a browser session. | ||
|
|
||
| | Flag | Description | | ||
| |------|-------------| | ||
| | `--output json`, `-o json` | Output raw JSON array. | | ||
|
|
||
| ### `kernel browsers replays start <session-id>` | ||
| Start recording a replay. | ||
|
|
||
| | Flag | Description | | ||
| |------|-------------| | ||
| | `--framerate <fps>` | Recording framerate in frames per second. | | ||
| | `--max-duration <seconds>` | Maximum recording duration. | | ||
| | `--output json`, `-o json` | Output raw JSON object. | | ||
|
|
||
| ### `kernel browsers replays stop <session-id> <replay-id>` | ||
| Stop an active replay recording. | ||
|
|
@@ -78,6 +99,7 @@ Execute a command synchronously inside the browser VM. | |
| | `--timeout <seconds>` | Execution timeout. | | ||
| | `--as-user <user>` | Run as a specific user. | | ||
| | `--as-root` | Run as root. | | ||
| | `--output json`, `-o json` | Output raw JSON object. | | ||
|
|
||
| ### `kernel browsers process spawn <session-id> [--] [command...]` | ||
| Execute a command asynchronously in the browser VM. | ||
|
|
@@ -90,6 +112,7 @@ Execute a command asynchronously in the browser VM. | |
| | `--timeout <seconds>` | Execution timeout. | | ||
| | `--as-user <user>` | Run as a specific user. | | ||
| | `--as-root` | Run as root. | | ||
| | `--output json`, `-o json` | Output raw JSON object. | | ||
|
|
||
| ### `kernel browsers process kill <session-id> <process-id>` | ||
| Send a signal to a process running in the browser VM. | ||
|
|
@@ -149,13 +172,15 @@ Retrieve metadata for a file or directory. | |
| | Flag | Description | | ||
| |------|-------------| | ||
| | `--path <path>` | Absolute file or directory path (required). | | ||
| | `--output json`, `-o json` | Output raw JSON object. | | ||
|
|
||
| ### `kernel browsers fs list-files <session-id>` | ||
| List directory contents. | ||
|
|
||
| | Flag | Description | | ||
| |------|-------------| | ||
| | `--path <path>` | Absolute directory path (required). | | ||
| | `--output json`, `-o json` | Output raw JSON array. | | ||
|
|
||
| ### `kernel browsers fs move <session-id>` | ||
| Move or rename a file or directory. | ||
|
|
@@ -295,12 +320,17 @@ Execute Playwright/TypeScript code against a running browser session. | |
| ### `kernel extensions list` | ||
| List all uploaded extensions. | ||
|
|
||
| | Flag | Description | | ||
| |------|-------------| | ||
| | `--output json`, `-o json` | Output raw JSON array. | | ||
|
|
||
| ### `kernel extensions upload <directory>` | ||
| Upload an unpacked extension directory. | ||
|
|
||
| | Flag | Description | | ||
| |------|-------------| | ||
| | `--name <name>` | Optional unique extension name. | | ||
| | `--output json`, `-o json` | Output raw JSON object. | | ||
|
|
||
| ### `kernel extensions download <id-or-name>` | ||
| Download an extension archive. | ||
|
|
@@ -332,9 +362,17 @@ Upload one or more unpacked Chrome extensions directly into a running browser se | |
| ### `kernel proxies list` | ||
| List available proxy configurations. | ||
|
|
||
| | Flag | Description | | ||
| |------|-------------| | ||
| | `--output json`, `-o json` | Output raw JSON array. | | ||
|
|
||
| ### `kernel proxies get <id>` | ||
| Show details for a proxy configuration. | ||
|
|
||
| | Flag | Description | | ||
| |------|-------------| | ||
| | `--output json`, `-o json` | Output raw JSON object. | | ||
|
|
||
| ### `kernel proxies create` | ||
| Create a new proxy configuration. | ||
|
|
||
|
|
@@ -354,10 +392,101 @@ Create a new proxy configuration. | |
| | `--port <port>` | Proxy port (custom; required). | | ||
| | `--username <username>` | Proxy username (custom). | | ||
| | `--password <password>` | Proxy password (custom). | | ||
| | `--output json`, `-o json` | Output raw JSON object. | | ||
|
|
||
| ### `kernel proxies delete <id>` | ||
| Delete a proxy configuration. | ||
|
|
||
| | Flag | Description | | ||
| |------|-------------| | ||
| | `--yes`, `-y` | Skip confirmation. | | ||
|
|
||
| ## Browser pools | ||
|
|
||
| For more details on browser pools, see [Browser Pools](/browsers/pools). | ||
|
|
||
| ### `kernel browser-pools list` | ||
| List all browser pools. | ||
|
|
||
| | Flag | Description | | ||
| |------|-------------| | ||
| | `--output json`, `-o json` | Output raw JSON array. | | ||
|
|
||
| ### `kernel browser-pools create` | ||
| Create a new browser pool. | ||
|
|
||
| | Flag | Description | | ||
| |------|-------------| | ||
| | `--name <name>` | Optional unique name for the pool. | | ||
| | `--size <n>` | Number of browsers in the pool (required). | | ||
| | `--fill-rate <n>` | Percentage of the pool to fill per minute. | | ||
| | `--timeout <seconds>` | Idle timeout for browsers acquired from the pool. | | ||
| | `--output json`, `-o json` | Output raw JSON object. | | ||
|
|
||
| ### `kernel browser-pools get <id-or-name>` | ||
| Get pool details. | ||
|
|
||
| | Flag | Description | | ||
| |------|-------------| | ||
| | `--output json`, `-o json` | Output raw JSON object. | | ||
|
|
||
| ### `kernel browser-pools update <id-or-name>` | ||
| Update pool configuration. | ||
|
|
||
| | Flag | Description | | ||
| |------|-------------| | ||
| | `--size <n>` | Updated pool size. | | ||
| | `--discard-all-idle` | Discard all idle browsers and refill. | | ||
| | `--output json`, `-o json` | Output raw JSON object. | | ||
|
|
||
| ### `kernel browser-pools acquire <id-or-name>` | ||
| Acquire a browser from the pool. | ||
|
|
||
| | Flag | Description | | ||
| |------|-------------| | ||
| | `--timeout <seconds>` | Acquire timeout before returning 204. | | ||
| | `--output json`, `-o json` | Output raw JSON object. | | ||
|
|
||
| ### `kernel browser-pools release <id-or-name>` | ||
| Release a browser back to the pool. | ||
|
|
||
| | Flag | Description | | ||
| |------|-------------| | ||
| | `--session-id <id>` | Browser session ID to release (required). | | ||
| | `--reuse` | Reuse the browser instance (default: true). | | ||
|
|
||
| ### `kernel browser-pools delete <id-or-name>` | ||
| Delete a pool. | ||
|
|
||
| | Flag | Description | | ||
| |------|-------------| | ||
| | `--force` | Force delete even if browsers are leased. | | ||
|
|
||
| ### `kernel browser-pools flush <id-or-name>` | ||
| Destroy all idle browsers in the pool. | ||
|
|
||
| ## Profiles | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. could cross link to /browsers/profiles page here |
||
|
|
||
| For more details on browser profiles, see [Profiles](/browsers/profiles). | ||
|
|
||
| ### `kernel profiles list` | ||
| List all browser profiles. | ||
|
|
||
| | Flag | Description | | ||
| |------|-------------| | ||
| | `--output json`, `-o json` | Output raw JSON array. | | ||
|
|
||
| ### `kernel profiles get <id-or-name>` | ||
| Get profile details. | ||
|
|
||
| | Flag | Description | | ||
| |------|-------------| | ||
| | `--output json`, `-o json` | Output raw JSON object. | | ||
|
|
||
| ### `kernel profiles create` | ||
| Create a new browser profile. | ||
|
|
||
| | Flag | Description | | ||
| |------|-------------| | ||
| | `--name <name>` | Optional unique name for the profile. | | ||
| | `--output json`, `-o json` | Output raw JSON object. | | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
could cross link to /browsers/pools page here