Skip to content

improve litcli documentation clarity #591

Open
@AndySchroder

Description

@AndySchroder

We have

$ litcli -h
NAME:
   litcli - control plane for your Lightning Terminal (lit) daemon

USAGE:
   litcli [global options] command [command options] [arguments...]

VERSION:
   0.10.1-alpha commit=v0.10.1-alpha

COMMANDS:
   actions  List actions performed on the Litd server
   help, h  Shows a list of commands or help for one command

   Accounts:
     accounts, a  manage accounts

   Autopilot:
     autopilot  manage autopilot sessions

   LiT:
     stop     shutdown the LiT daemon
     getinfo  Returns basic information related to the active daemon.

   Privacy:
     privacy, p  Access the real-pseudo string pairs of the privacy mapper

   Sessions:
     sessions, s  manage Terminal Web sessions

GLOBAL OPTIONS:
   --rpcserver value          lit daemon address host:port (default: "localhost:8443")
   --network value, -n value  the network litd is running on e.g. mainnet, testnet, etc. (default: "mainnet")
   --basedir value            path to lit's base directory (default: "/home/lnd/.lit")
   --tlscertpath value        path to lit's TLS certificate (default: "/home/lnd/.lit/tls.cert")
   --macaroonpath value       path to lit's macaroon file (default: "/home/lnd/.lit/mainnet/lit.macaroon")
   --help, -h                 show help
   --version, -v              print the version

however

  • I can't find any explanation of what the "privacy mapper" is and,
  • sessions seems to manage more than just terminal web sessions, it seems to manage all lightning node connect sessions.

Metadata

Metadata

Assignees

No one assigned

    Labels

    beginnerdocumentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions