rk debug
Summary
Unified CDP+DAP debug session commands for Roku devices (server mode only).
Description
Unified debug session commands require a running rk server. Start it with 'rk server'.
Usage
rk debug <subcommand> [options]session create
Summary
Create a new unified debug session
Description
Create a new unified debug session
Usage
rk debug session create --root <path> [options]Options
| Flag | Value/type | Allowed values | Default | Required |
|---|---|---|---|---|
--root | path (string) | — | — | yes |
--mode | cdp_only|dap_only|unified (string) | cdp_only, dap_only, unified | — | no |
--device | id (string) | — | — | no |
--host | ip (string) | — | — | no |
--password | pwd (string) | — | — | no |
--config | name (string) | — | — | no |
--connection-mode | watch|manual (string) | watch, manual | watch | no |
--coordinated-stop | boolean | — | — | no |
--resume-on-end | boolean | — | — | no |
--auto-stop | boolean | — | — | no |
--json | boolean | — | — | no |
--root
Project root for 'session create' (required)
--mode
Backend mode for 'session create'/'session update'
--device
Target device for 'session create'
--host
Target device IP for 'session create'
--password
Device password for 'session create'
--config
Config name for 'session create'
--connection-mode
Reconnect behavior for 'session create': 'watch' auto-reconnects if the connection drops, 'manual' does not
--coordinated-stop
Enable coordinated stop for 'session create'/'session update'
--resume-on-end
Resume execution when 'session create' ends
--auto-stop
Halt the app automatically for 'session create'
--json
Output raw JSON response
Examples
rk debug session create --root . --mode unifiedSee also
- debugCreateSession (
POST /api/debug/session/create) - debug_session_create
session update
Summary
Update an active debug session
Description
Update an active debug session
Usage
rk debug session update [options]Options
| Flag | Value/type | Allowed values | Required |
|---|---|---|---|
--session | id (string) | — | no |
--mode | cdp_only|dap_only|unified (string) | cdp_only, dap_only, unified | no |
--coordinated-stop | boolean | — | no |
--rebuild | boolean | — | no |
--json | boolean | — | no |
--session
Target session ID
--mode
Backend mode for 'session create'/'session update'
--coordinated-stop
Enable coordinated stop for 'session create'/'session update'
--rebuild
Rebuild and reapply breakpoints for 'session update'
--json
Output raw JSON response
See also
- debugUpdateSession (
POST /api/debug/session/update) - debug_session_update
session end
Summary
End an active debug session
Description
End an active debug session
Usage
rk debug session end [options]Options
| Flag | Value/type | Required |
|---|---|---|
--session | id (string) | no |
--continue-first | boolean | no |
--json | boolean | no |
--session
Target session ID
--continue-first
Continue execution before ending for 'session end'
--json
Output raw JSON response
See also
- debugEndSession (
POST /api/debug/session/end) - debug_session_end
session status
Summary
Show active debug session status
Description
Show active debug session status
Usage
rk debug session status [options]Options
| Flag | Value/type | Required |
|---|---|---|
--session | id (string) | no |
--json | boolean | no |
--session
Target session ID
--json
Output raw JSON response
Examples
rk debug session statusSee also
- debugGetSessionStatus (
GET /api/debug/session/status) - debug_session_status
stacktrace
Summary
Get the current call stack
Description
Get the current call stack
Usage
rk debug stacktrace [options]Options
| Flag | Value/type | Required |
|---|---|---|
--session | id (string) | no |
--thread | id (string) | no |
--json | boolean | no |
--session
Target session ID
--thread
Target thread ID
--json
Output raw JSON response
See also
- debugGetStackTrace (
GET /api/debug/stacktrace) - debug_stacktrace
state
Summary
Get combined CDP+DAP debugger state
Description
Get combined CDP+DAP debugger state
Usage
rk debug state [options]Options
| Flag | Value/type | Required |
|---|---|---|
--session | id (string) | no |
--json | boolean | no |
--session
Target session ID
--json
Output raw JSON response
See also
- debugGetState (
GET /api/debug/state) - debug_state
eval
Summary
Evaluate an expression
Description
Evaluate an expression
Usage
rk debug eval <expr> [options]| Argument | Description | Required | Repeatable |
|---|---|---|---|
| expr | Expression to evaluate. Multiple arguments are joined with spaces into one expression. | yes | yes |
Options
| Flag | Value/type | Allowed values | Required |
|---|---|---|---|
--runtime | typescript|brightscript (string) | typescript, brightscript | no |
--frame-index | n (number) | — | no |
--thread | id (string) | — | no |
--print | boolean | — | no |
--session | id (string) | — | no |
--json | boolean | — | no |
--runtime
Backend to target for 'eval'/'continue'/'step'
--frame-index
Stack frame index
--thread
Target thread ID
--print
Print BrightScript eval result to the device console
--session
Target session ID
--json
Output raw JSON response
Examples
rk debug eval "1 + 1" --runtime typescriptSee also
- debugEval (
POST /api/debug/eval) - debug_eval
breakpoint set
Summary
Set a line breakpoint
Description
Set a line breakpoint
Usage
rk debug breakpoint set <file> <line> [options]| Argument | Description | Required | Repeatable |
|---|---|---|---|
| file | File to set the line breakpoint in. | yes | no |
| line | Line to set the line breakpoint at; must be a positive integer. | yes | no |
Options
| Flag | Value/type | Required |
|---|---|---|
--condition | expr (string) | no |
--ignore-count | n (number) | no |
--session | id (string) | no |
--json | boolean | no |
--condition
Conditional breakpoint expression for 'breakpoint set'
--ignore-count
Ignore count for 'breakpoint set'
--session
Target session ID
--json
Output raw JSON response
Examples
rk debug breakpoint set src/main.brs 42See also
- debugSetBreakpoint (
POST /api/debug/breakpoint/set) - debug_breakpoint_set
breakpoint remove
Summary
Remove a breakpoint by ID
Description
Remove a breakpoint by ID
Usage
rk debug breakpoint remove <id> [options]| Argument | Description | Required | Repeatable |
|---|---|---|---|
| id | ID of the breakpoint to remove. | yes | no |
Options
| Flag | Value/type | Required |
|---|---|---|
--session | id (string) | no |
--json | boolean | no |
--session
Target session ID
--json
Output raw JSON response
See also
- debugRemoveBreakpoint (
POST /api/debug/breakpoint/remove) - debug_breakpoint_remove
breakpoints list
Summary
List all breakpoints
Description
List all breakpoints
Usage
rk debug breakpoints list [options]Options
| Flag | Value/type | Required |
|---|---|---|
--session | id (string) | no |
--json | boolean | no |
--session
Target session ID
--json
Output raw JSON response
See also
- debugListBreakpoints (
GET /api/debug/breakpoints/list) - debug_breakpoints_list
exception-breakpoints set
Summary
Set exception breakpoint filters
Description
Set exception breakpoint filters
Usage
rk debug exception-breakpoints set [options]Options
| Flag | Value/type | Required |
|---|---|---|
--caught | boolean | no |
--caught-condition | expr (string) | no |
--uncaught | boolean | no |
--uncaught-condition | expr (string) | no |
--session | id (string) | no |
--json | boolean | no |
--caught
Break on caught exceptions for 'exception-breakpoints set'
--caught-condition
Condition for caught exceptions
--uncaught
Break on uncaught exceptions for 'exception-breakpoints set'
--uncaught-condition
Condition for uncaught exceptions
--session
Target session ID
--json
Output raw JSON response
See also
- debugSetExceptionBreakpoints (
POST /api/debug/exception-breakpoints/set) - debug_exception_breakpoints_set
continue
Summary
Resume execution
Description
Resume execution
Usage
rk debug continue [options]Options
| Flag | Value/type | Allowed values | Required |
|---|---|---|---|
--runtime | typescript|brightscript (string) | typescript, brightscript | no |
--session | id (string) | — | no |
--json | boolean | — | no |
--runtime
Backend to target for 'eval'/'continue'/'step'
--session
Target session ID
--json
Output raw JSON response
Examples
rk debug continueSee also
- debugContinue (
POST /api/debug/continue) - debug_continue
step
Summary
Step execution
Description
Step execution
Usage
rk debug step over|into|out [options]| Argument | Description | Required | Repeatable |
|---|---|---|---|
| over|into|out | How to step: over, into or out. | yes | no |
Options
| Flag | Value/type | Allowed values | Required |
|---|---|---|---|
--thread | id (string) | — | no |
--runtime | typescript|brightscript (string) | typescript, brightscript | no |
--session | id (string) | — | no |
--json | boolean | — | no |
--thread
Target thread ID
--runtime
Backend to target for 'eval'/'continue'/'step'
--session
Target session ID
--json
Output raw JSON response
See also
- debugStep (
POST /api/debug/step) - debug_step
stop
Summary
Stop (pause) execution
Description
Stop (pause) execution
Usage
rk debug stop [options]Options
| Flag | Value/type | Required |
|---|---|---|
--session | id (string) | no |
--json | boolean | no |
--session
Target session ID
--json
Output raw JSON response
See also
- debugStop (
POST /api/debug/stop) - debug_stop
console
Summary
Get buffered console output
Description
Get buffered console output
Usage
rk debug console [options]Options
| Flag | Value/type | Allowed values | Default | Required |
|---|---|---|---|---|
--source | ts|brs|device (string) | ts, brs, device | — | no |
--level | level (string) | log, warn, error, info, debug, print | — | no |
--limit | n (number) | — | 50 | no |
--since | ms (number) | — | — | no |
--session | id (string) | — | — | no |
--json | boolean | — | — | no |
--source
Backend to filter by for 'console'/'console clear'/'errors'
--level
Filter 'console' by level
--limit
Max entries to return for 'console'/'errors'
--since
Only entries newer than this timestamp for 'console'/'errors'
--session
Target session ID
--json
Output raw JSON response
See also
- debugReadConsole (
GET /api/debug/console) - debug_console_read
console clear
Summary
Clear console/error buffers
Description
Clear console/error buffers
Usage
rk debug console clear [options]Options
| Flag | Value/type | Allowed values | Default | Required |
|---|---|---|---|---|
--target | console|errors|both (string) | console, errors, both | both | no |
--source | ts|brs|device (string) | ts, brs, device | — | no |
--session | id (string) | — | — | no |
--json | boolean | — | — | no |
--target
Buffer(s) to clear for 'console clear'
--source
Backend to filter by for 'console'/'console clear'/'errors'
--session
Target session ID
--json
Output raw JSON response
See also
- debugClearConsole (
POST /api/debug/console/clear) - debug_console_clear
errors
Summary
Get buffered error messages
Description
Get buffered error messages
Usage
rk debug errors [options]Options
| Flag | Value/type | Allowed values | Default | Required |
|---|---|---|---|---|
--source | ts|brs|device (string) | ts, brs, device | — | no |
--limit | n (number) | — | 50 | no |
--since | ms (number) | — | — | no |
--session | id (string) | — | — | no |
--json | boolean | — | — | no |
--source
Backend to filter by for 'console'/'console clear'/'errors'
--limit
Max entries to return for 'console'/'errors'
--since
Only entries newer than this timestamp for 'console'/'errors'
--session
Target session ID
--json
Output raw JSON response
See also
- debugReadErrors (
GET /api/debug/errors) - debug_errors_read
Updated about 3 hours ago