@@ -17,24 +17,6 @@ parameters in <angle brackets>.
1717
1818## API Commands
1919
20- ### ` warcli debug-log `
21- Fetch the Bitcoin Core debug log from \< node> in [ network]
22-
23- options:
24- | name | type | required | default |
25- | ---------| --------| ------------| -----------|
26- | node | Int | yes | |
27- | network | String | | "warnet" |
28-
29- ### ` warcli grep-logs `
30- Grep combined logs via fluentd using regex \< pattern>
31-
32- options:
33- | name | type | required | default |
34- | ---------| --------| ------------| -----------|
35- | pattern | String | yes | |
36- | network | String | | "warnet" |
37-
3820### ` warcli help `
3921Display help information for the given [ command] (and sub-command).
4022 If no command is given, display help for the main CLI.
@@ -44,17 +26,31 @@ options:
4426| ----------| --------| ------------| -----------|
4527| commands | String | | |
4628
47- ### ` warcli lncli `
48- Call lightning cli \< command> on \< node> in [ network]
29+ ### ` warcli setup `
30+ Run the Warnet quick start setup script
31+
32+
33+ ## Bitcoin
34+
35+ ### ` warcli bitcoin debug-log `
36+ Fetch the Bitcoin Core debug log from \< node> in [ network]
4937
5038options:
5139| name | type | required | default |
5240| ---------| --------| ------------| -----------|
5341| node | Int | yes | |
54- | command | String | yes | |
5542| network | String | | "warnet" |
5643
57- ### ` warcli messages `
44+ ### ` warcli bitcoin grep-logs `
45+ Grep combined logs via fluentd using regex \< pattern>
46+
47+ options:
48+ | name | type | required | default |
49+ | ---------| --------| ------------| -----------|
50+ | pattern | String | yes | |
51+ | network | String | | "warnet" |
52+
53+ ### ` warcli bitcoin messages `
5854Fetch messages sent between \< node_a> and \< node_b> in [ network]
5955
6056options:
@@ -64,7 +60,7 @@ options:
6460| node_b | Int | yes | |
6561| network | String | | "warnet" |
6662
67- ### ` warcli rpc `
63+ ### ` warcli bitcoin rpc `
6864Call bitcoin-cli \< method> [ params] on \< node> in [ network]
6965
7066options:
@@ -75,8 +71,22 @@ options:
7571| params | String | | |
7672| network | String | | "warnet" |
7773
78- ### ` warcli stop `
79- Stop warnet.
74+ ## Cluster
75+
76+ ### ` warcli cluster port-start `
77+ Port forward (runs as a detached process)
78+
79+
80+ ### ` warcli cluster port-stop `
81+ Stop the port forwarding process
82+
83+
84+ ### ` warcli cluster start `
85+ Setup and start Warnet with minikube
86+
87+
88+ ### ` warcli cluster stop `
89+ Stop the warnet server and tear down the cluster
8090
8191
8292## Graph
@@ -133,6 +143,27 @@ options:
133143| arches | String | | |
134144| action | String | | |
135145
146+ ## Ln
147+
148+ ### ` warcli ln pubkey `
149+ Get lightning node pub key on \< node> in [ network]
150+
151+ options:
152+ | name | type | required | default |
153+ | ---------| --------| ------------| -----------|
154+ | node | Int | yes | |
155+ | network | String | | "warnet" |
156+
157+ ### ` warcli ln rpc `
158+ Call lightning cli rpc \< command> on \< node> in [ network]
159+
160+ options:
161+ | name | type | required | default |
162+ | ---------| --------| ------------| -----------|
163+ | node | Int | yes | |
164+ | command | String | yes | |
165+ | network | String | | "warnet" |
166+
136167## Network
137168
138169### ` warcli network connected `
@@ -176,11 +207,11 @@ options:
176207Start a warnet with topology loaded from a \< graph_file> into [ network]
177208
178209options:
179- | name | type | required | default |
180- | ------------| --------| ------------| ----------------------------|
181- | graph_file | Path | | src/graphs/default.graphml |
182- | force | Bool | | False |
183- | network | String | | "warnet" |
210+ | name | type | required | default |
211+ | ------------| --------| ------------| ----------------------------------- |
212+ | graph_file | Path | | src/warnet/ graphs/default.graphml |
213+ | force | Bool | | False |
214+ | network | String | | "warnet" |
184215
185216### ` warcli network status `
186217Get status of a warnet named [ network]
@@ -226,6 +257,7 @@ options:
226257| -----------------| --------| ------------| -----------|
227258| scenario_path | String | yes | |
228259| additional_args | String | | |
260+ | name | String | | |
229261| network | String | | "warnet" |
230262
231263### ` warcli scenarios stop `
0 commit comments