Skip to content

Commit c60a6d7

Browse files
committed
update docs
1 parent 3ff9c53 commit c60a6d7

File tree

1 file changed

+12
-142
lines changed

1 file changed

+12
-142
lines changed

docs/warcli.md

Lines changed: 12 additions & 142 deletions
Original file line numberDiff line numberDiff line change
@@ -30,87 +30,6 @@ options:
3030
Check Warnet requirements are installed
3131

3232

33-
## Bitcoin
34-
35-
### `warcli bitcoin debug-log`
36-
Fetch the Bitcoin Core debug log from \<node> in [network]
37-
38-
options:
39-
| name | type | required | default |
40-
|---------|--------|------------|-----------|
41-
| node | Int | yes | |
42-
| network | String | | "warnet" |
43-
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-
| show_k8s_timestamps | Bool | | False |
52-
| no_sort | Bool | | False |
53-
| network | String | | "warnet" |
54-
55-
### `warcli bitcoin messages`
56-
Fetch messages sent between \<node_a> and \<node_b> in [network]
57-
58-
options:
59-
| name | type | required | default |
60-
|---------|--------|------------|-----------|
61-
| node_a | Int | yes | |
62-
| node_b | Int | yes | |
63-
| network | String | | "warnet" |
64-
65-
### `warcli bitcoin rpc`
66-
Call bitcoin-cli \<method> [params] on \<node> in [network]
67-
68-
options:
69-
| name | type | required | default |
70-
|---------|--------|------------|-----------|
71-
| node | Int | yes | |
72-
| method | String | yes | |
73-
| params | String | | |
74-
| network | String | | "warnet" |
75-
76-
## Cluster
77-
78-
### `warcli cluster connect-logging`
79-
Connect kubectl to cluster logging
80-
81-
82-
### `warcli cluster deploy`
83-
Deploy Warnet using the current kubectl-configured cluster
84-
85-
options:
86-
| name | type | required | default |
87-
|--------|--------|------------|-----------|
88-
| dev | Bool | | False |
89-
90-
### `warcli cluster deploy-logging`
91-
Deploy logging configurations to the cluster using helm
92-
93-
94-
### `warcli cluster port-start`
95-
Port forward (runs as a detached process)
96-
97-
98-
### `warcli cluster port-stop`
99-
Stop the port forwarding process
100-
101-
102-
### `warcli cluster setup-minikube`
103-
Configure a local minikube cluster
104-
105-
options:
106-
| name | type | required | default |
107-
|--------|--------|------------|-----------|
108-
| clean | Bool | | False |
109-
110-
### `warcli cluster teardown`
111-
Stop the warnet server and tear down the cluster
112-
113-
11433
## Graph
11534

11635
### `warcli graph create`
@@ -165,36 +84,15 @@ options:
16584
| arches | String | | |
16685
| action | String | | "load" |
16786

168-
## Ln
169-
170-
### `warcli ln pubkey`
171-
Get lightning node pub key on \<node> in [network]
172-
173-
options:
174-
| name | type | required | default |
175-
|---------|--------|------------|-----------|
176-
| node | Int | yes | |
177-
| network | String | | "warnet" |
178-
179-
### `warcli ln rpc`
180-
Call lightning cli rpc \<command> on \<node> in [network]
181-
182-
options:
183-
| name | type | required | default |
184-
|---------|--------|------------|-----------|
185-
| node | Int | yes | |
186-
| command | String | yes | |
187-
| network | String | | "warnet" |
188-
18987
## Network
19088

191-
### `warcli network connected`
192-
Indicate whether the all of the edges in the gaph file are connected in [network]
89+
### `warcli network connect`
90+
Connect nodes based on the edges defined in the graph file.
19391

19492
options:
195-
| name | type | required | default |
196-
|---------|--------|------------|-----------|
197-
| network | String | | "warnet" |
93+
| name | type | required | default |
94+
|------------|--------|------------|----------------------------------|
95+
| graph_file | Path | | resources/graphs/default.graphml |
19896

19997
### `warcli network down`
20098
Bring down a running warnet named [network]
@@ -204,26 +102,14 @@ options:
204102
|---------|--------|------------|-----------|
205103
| network | String | | "warnet" |
206104

207-
### `warcli network export`
208-
Export all [network] data for a "simln" service running in a container
209-
on the network. Optionally add JSON string [activity] to simln config.
210-
Optionally provide a list of tank indexes to [exclude].
211-
Returns True on success.
212-
213-
options:
214-
| name | type | required | default |
215-
|----------|--------|------------|-----------|
216-
| network | String | | "warnet" |
217-
| activity | String | | |
218-
| exclude | String | | "[]" |
219-
220-
### `warcli network info`
221-
Get info about a warnet named [network]
105+
### `warcli network generate-yaml`
106+
Generate a Kubernetes YAML file from a graph file for deploying warnet nodes.
222107

223108
options:
224-
| name | type | required | default |
225-
|---------|--------|------------|-----------|
226-
| network | String | | "warnet" |
109+
| name | type | required | default |
110+
|------------|--------|------------|----------------------------------|
111+
| graph_file | Path | | resources/graphs/default.graphml |
112+
| output | String | | "warnet-deployment.yaml" |
227113

228114
### `warcli network logs`
229115
Get Kubernetes logs from the RPC server
@@ -240,24 +126,8 @@ options:
240126
| name | type | required | default |
241127
|------------|--------|------------|----------------------------------|
242128
| graph_file | Path | | resources/graphs/default.graphml |
243-
| force | Bool | | False |
244129
| network | String | | "warnet" |
245-
246-
### `warcli network status`
247-
Get status of a warnet named [network]
248-
249-
options:
250-
| name | type | required | default |
251-
|---------|--------|------------|-----------|
252-
| network | String | | "warnet" |
253-
254-
### `warcli network up`
255-
Bring up a previously-stopped warnet named [network]
256-
257-
options:
258-
| name | type | required | default |
259-
|---------|--------|------------|-----------|
260-
| network | String | | "warnet" |
130+
| logging | Bool | | False |
261131

262132
## Scenarios
263133

0 commit comments

Comments
 (0)