GlcoinCore/lndk
1
0
Fork 0
mirror of https://github.com/lndk-org/lndk.git synced 2026-08-13 12:33:05 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #243 from a-mpch/2025-09-cli-docs

Browse source 
cli: add docs for macaroon and grpc options
This commit is contained in:
Maurice Poirrier 2025-09-30 16:17:43 +02:00 • committed by GitHub
commit ac719ea70c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 6 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

7
src/cli.rs
View file

@ -68,10 +68,13 @@ struct Cli {
)]
network: String,
/// Option for passing a file path to a macaroon file obtained from LND node.
/// Either this option or macaroon_hex must be set, there is no default.
#[arg(short, long, global = true, required = false)]
macaroon_path: Option<PathBuf>,
/// A hex-encoded macaroon string to pass in directly to the cli.
/// A hex-encoded macaroon string to pass in directly to the cli to authenticate with LND node.
/// Either this option or macaroon_path must be set, there is no default.
#[arg(long, global = true, required = false)]
macaroon_hex: Option<String>,
@ -89,9 +92,11 @@ struct Cli {
#[arg(long, global = true, required = false)]
cert_path: Option<PathBuf>,
/// Host of the LNDK server.
#[arg(long, global = true, required = false, default_value = format!("https://{DEFAULT_SERVER_HOST}"))]
grpc_host: String,
/// Port of the LNDK server.
#[arg(long, global = true, required = false, default_value = DEFAULT_SERVER_PORT.to_string())]
grpc_port: u16,