Skip to content

Commit

Permalink
Update apidocs on
Browse files Browse the repository at this point in the history
  • Loading branch information
pinheadmz authored and github-actions[bot] committed Dec 23, 2024
1 parent 85ed1d6 commit 5039591
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions docs/warnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,15 @@ options:
|--------|--------|------------|-----------|
| force | Bool | | False |

### `warnet import-network`
Create a network from an imported lightning network graph JSON

options:
| name | type | required | default |
|-----------------|--------|------------|-----------|
| graph_file_path | Path | yes | |
| output_path | Path | yes | |

### `warnet init`
Initialize a warnet project in the current directory

Expand Down Expand Up @@ -192,4 +201,33 @@ options:
| arches | String | | |
| action | String | | "load" |

## Ln

### `warnet ln host`
Get lightning node host from \<ln pod name>

options:
| name | type | required | default |
|--------|--------|------------|-----------|
| pod | String | yes | |

### `warnet ln pubkey`
Get lightning node pub key from \<ln pod name>

options:
| name | type | required | default |
|--------|--------|------------|-----------|
| pod | String | yes | |

### `warnet ln rpc`
Call lightning cli rpc \<command> on \<ln pod name>

options:
| name | type | required | default |
|-----------|--------|------------|-----------|
| pod | String | yes | |
| method | String | yes | |
| params | String | | |
| namespace | String | | |


0 comments on commit 5039591

Please sign in to comment.