forked from Timi16/soroban-debugger
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsoroban-debug-remote.1
More file actions
125 lines (113 loc) · 4.87 KB
/
Copy pathsoroban-debug-remote.1
File metadata and controls
125 lines (113 loc) · 4.87 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.TH remote 1 "remote "
.SH NAME
remote \- Connect to remote debug server
.SH SYNOPSIS
\fBremote\fR <\fB\-r\fR|\fB\-\-remote\fR> [\fB\-t\fR|\fB\-\-token\fR] [\fB\-c\fR|\fB\-\-contract\fR] [\fB\-f\fR|\fB\-\-function\fR] [\fB\-\-tls\-cert\fR] [\fB\-\-tls\-key\fR] [\fB\-\-tls\-ca\fR] [\fB\-\-session\-label\fR] [\fB\-a\fR|\fB\-\-args\fR] [\fB\-\-connect\-timeout\-ms\fR] [\fB\-\-timeout\-ms\fR] [\fB\-\-inspect\-timeout\-ms\fR] [\fB\-\-storage\-timeout\-ms\fR] [\fB\-\-retry\-attempts\fR] [\fB\-\-retry\-base\-delay\-ms\fR] [\fB\-\-retry\-max\-delay\-ms\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fIremote and server\fR]
\fBremote\fR <\fB\-r\fR|\fB\-\-remote\fR> [\fB\-t\fR|\fB\-\-token\fR] [\fB\-c\fR|\fB\-\-contract\fR] [\fB\-f\fR|\fB\-\-function\fR] [\fB\-\-tls\-cert\fR] [\fB\-\-tls\-key\fR] [\fB\-\-tls\-ca\fR] [\fB\-\-session\-label\fR] [\fB\-a\fR|\fB\-\-args\fR] [\fB\-\-connect\-timeout\-ms\fR] [\fB\-\-timeout\-ms\fR] [\fB\-\-inspect\-timeout\-ms\fR] [\fB\-\-storage\-timeout\-ms\fR] [\fB\-\-retry\-attempts\fR] [\fB\-\-retry\-base\-delay\-ms\fR] [\fB\-\-retry\-max\-delay\-ms\fR] [\fB\-\-format\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fIremote and server\fR]
.SH DESCRIPTION
Connect to remote debug server
.SH OPTIONS
.TP
\fB\-r\fR, \fB\-\-remote\fR \fI<REMOTE>\fR
Remote server address (e.g., localhost:9229)
.TP
\fB\-t\fR, \fB\-\-token\fR \fI<TOKEN>\fR
Authentication token (if required by server)
.TP
\fB\-c\fR, \fB\-\-contract\fR \fI<CONTRACT>\fR
Path to the contract WASM file
.TP
\fB\-f\fR, \fB\-\-function\fR \fI<FUNCTION>\fR
Function name to execute
.TP
\fB\-\-tls\-cert\fR \fI<TLS_CERT>\fR
TLS certificate file path (optional)
.TP
\fB\-\-tls\-key\fR \fI<TLS_KEY>\fR
TLS private key file path (optional)
.TP
\fB\-\-tls\-ca\fR \fI<TLS_CA>\fR
TLS CA certificate file path (optional, for self\-signed certs)
.TP
\fB\-\-session\-label\fR \fI<SESSION_LABEL>\fR
Optional label for the remote session (helps identify sessions in logs)
.TP
\fB\-a\fR, \fB\-\-args\fR \fI<ARGS>\fR
Function arguments as JSON array
.TP
\fB\-\-connect\-timeout\-ms\fR \fI<MS>\fR [default: 10000]
Timeout in milliseconds for the initial TCP connection to the remote server.
Use this when the server is on a slow or restricted network and the default connect attempt feels hung or fails unpredictably. Distinct from \-\-timeout\-ms, which governs individual request/response round\-trips after the connection is already established.
Default: 10 000 ms (10 seconds).
.RS
May also be specified with the \fBSOROBAN_DEBUG_CONNECT_TIMEOUT_MS\fR environment variable.
.RE
.TP
\fB\-\-timeout\-ms\fR \fI<MS>\fR [default: 30000]
Per\-request timeout in milliseconds for regular operations (execute, storage, inspect).
Default: 30 000 ms (30 seconds).
.RS
May also be specified with the \fBSOROBAN_DEBUG_REQUEST_TIMEOUT_MS\fR environment variable.
.RE
.TP
\fB\-\-inspect\-timeout\-ms\fR \fI<MS>\fR
Per\-request timeout in milliseconds specifically for Inspect calls.
Inspect fetches execution state metadata and can be slower than a simple ping. Defaults to \-\-timeout\-ms when not provided.
.RS
May also be specified with the \fBSOROBAN_DEBUG_INSPECT_TIMEOUT_MS\fR environment variable.
.RE
.TP
\fB\-\-storage\-timeout\-ms\fR \fI<MS>\fR
Per\-request timeout in milliseconds specifically for GetStorage calls.
Storage fetches can be large; set this higher than \-\-timeout\-ms for contracts with many storage keys. Defaults to \-\-timeout\-ms when not provided.
.RS
May also be specified with the \fBSOROBAN_DEBUG_STORAGE_TIMEOUT_MS\fR environment variable.
.RE
.TP
\fB\-\-retry\-attempts\fR \fI<N>\fR [default: 3]
Maximum number of retry attempts for idempotent requests (ping, inspect, storage).
Must be at least 1. Use 1 to disable retries entirely (one attempt, no retry).
Default: 3.
.TP
\fB\-\-retry\-base\-delay\-ms\fR \fI<MS>\fR [default: 200]
Base delay in milliseconds between retry attempts (exponential back\-off).
Must be greater than 0 and no larger than \-\-retry\-max\-delay\-ms.
Default: 200 ms.
.TP
\fB\-\-retry\-max\-delay\-ms\fR \fI<MS>\fR [default: 2000]
Maximum delay in milliseconds between retry attempts.
Must be greater than or equal to \-\-retry\-base\-delay\-ms.
Default: 2 000 ms.
.TP
\fB\-\-format\fR \fI<FORMAT>\fR [default: pretty]
Output format for remote command (pretty, json)
.br
.br
\fIPossible values:\fR
.RS 14
.IP \(bu 2
pretty
.IP \(bu 2
json
.RE
.TP
\fB\-h\fR, \fB\-\-help\fR
Print help (see a summary with \*(Aq\-h\*(Aq)
.SH "Remote and Server"
.TP
remote\-inspect(1)
Inspect current execution state (function, step count, call stack)
.TP
remote\-storage(1)
Get contract storage state as JSON
.TP
remote\-evaluate(1)
Evaluate an expression in the current debug context
.TP
remote\-preflight(1)
Run a preflight check: connect, handshake, auth, and optional TLS validation without loading a contract. Suitable for CI health checks and troubleshooting
.TP
remote\-help(1)
Print this message or the help of the given subcommand(s)