README
¶
skywire cli
Command-line documentation for skywire cli lives at
/docs/skywire/cli/README.md.
That tree is generated from the live cobra command structure — one
markdown file per command, mirroring the subcommand hierarchy. Run
skywire doc from the repo root to regenerate after CLI changes.
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cliuptime cmd/skywire-cli/cliuptime/cliuptime.go c4-vis-cli the discovery-integrated /uptimes endpoints.
|
Package cliuptime cmd/skywire-cli/cliuptime/cliuptime.go c4-vis-cli the discovery-integrated /uptimes endpoints. |
|
Package cliutil cmd/skywire-cli/cliutil/cliutil.go c4-vis-cli
|
Package cliutil cmd/skywire-cli/cliutil/cliutil.go c4-vis-cli |
|
livetui
Package livetui cmd/skywire-cli/cliutil/livetui/livetui.go c4-vis-cli helper.
|
Package livetui cmd/skywire-cli/cliutil/livetui/livetui.go c4-vis-cli helper. |
|
pterm
Package pterm cmd/skywire-cli/cliutil/pterm/pterm.go c5-cli-util
|
Package pterm cmd/skywire-cli/cliutil/pterm/pterm.go c5-cli-util |
|
putils
Package putils cmd/skywire-cli/cliutil/putils/putils.go c5-cli-util
|
Package putils cmd/skywire-cli/cliutil/putils/putils.go c5-cli-util |
|
Package commands cmd/skywire-cli/commands/root.go c4-vis-cli
|
Package commands cmd/skywire-cli/commands/root.go c4-vis-cli |
|
completion
Package clicompletion cmd/skywire-cli/commands/completion/completion.go c4-vis-cli
|
Package clicompletion cmd/skywire-cli/commands/completion/completion.go c4-vis-cli |
|
config
Package cliconfig cmd/skywire-cli/commands/config/deployment.go c4-vis-cli
|
Package cliconfig cmd/skywire-cli/commands/config/deployment.go c4-vis-cli |
|
contacts
Package clicontacts cmd/skywire-cli/commands/contacts/contacts.go c4-vis-cli
|
Package clicontacts cmd/skywire-cli/commands/contacts/contacts.go c4-vis-cli |
|
dmsg
Package clidmsg cmd/skywire-cli/commands/dmsg/attach.go c4-vis-cli `skywire cli dmsg attach` — inspect and exercise a local visor's dmsg relay acceptor (pkg/visor/init_dmsg_relay_local.go).
|
Package clidmsg cmd/skywire-cli/commands/dmsg/attach.go c4-vis-cli `skywire cli dmsg attach` — inspect and exercise a local visor's dmsg relay acceptor (pkg/visor/init_dmsg_relay_local.go). |
|
edit
Package cliedit cmd/skywire-cli/commands/edit/edit.go c4-vis-cli
|
Package cliedit cmd/skywire-cli/commands/edit/edit.go c4-vis-cli |
|
got
Package cligot cmd/skywire-cli/commands/got/got.go c4-vis-cli
|
Package cligot cmd/skywire-cli/commands/got/got.go c4-vis-cli |
|
gotop
Package cligotop cmd/skywire-cli/commands/gotop/grpcdevice.go c4-vis-cli
|
Package cligotop cmd/skywire-cli/commands/gotop/grpcdevice.go c4-vis-cli |
|
hv
Package clihv cmd/skywire-cli/commands/hv/bidi.go c4-vis-cli WebDriver BiDi support for the `hv` browser rigs, so `hv eval` and `hv probe` drive Waterfox/Firefox as well as Chromium/Brave.
|
Package clihv cmd/skywire-cli/commands/hv/bidi.go c4-vis-cli WebDriver BiDi support for the `hv` browser rigs, so `hv eval` and `hv probe` drive Waterfox/Firefox as well as Chromium/Brave. |
|
jq
Package clijq cmd/skywire-cli/commands/jq/jq.go c4-vis-cli
|
Package clijq cmd/skywire-cli/commands/jq/jq.go c4-vis-cli |
|
log
Package clilog cmd/skywire-cli/commands/log/dmsghttp_client.go c4-vis-cli
|
Package clilog cmd/skywire-cli/commands/log/dmsghttp_client.go c4-vis-cli |
|
mail
Package climail cmd/skywire-cli/commands/mail/attachments.go c4-vis-cli
|
Package climail cmd/skywire-cli/commands/mail/attachments.go c4-vis-cli |
|
mdisc
Package climdisc cmd/skywire-cli/commands/mdisc/check.go c4-vis-cli
|
Package climdisc cmd/skywire-cli/commands/mdisc/check.go c4-vis-cli |
|
proxy
Package skysocksc cmd/skywire-cli/commands/proxy/loadtest.go c4-vis-cli
|
Package skysocksc cmd/skywire-cli/commands/proxy/loadtest.go c4-vis-cli |
|
pty
Package clipty cmd/skywire-cli/commands/pty/root.go c4-vis-cli the unified namespace for the skywire pty subsystem: a remote shell and a remote-filesystem mount, plus the host (server) side, all keyed by public key over a noise-XK connection (no SSH involved).
|
Package clipty cmd/skywire-cli/commands/pty/root.go c4-vis-cli the unified namespace for the skywire pty subsystem: a remote shell and a remote-filesystem mount, plus the host (server) side, all keyed by public key over a noise-XK connection (no SSH involved). |
|
ptyfs
Package cliptyfs cmd/skywire-cli/commands/ptyfs/identity_linux.go c4-vis-cli destination parsing + identity loading helpers used by the linux mount path.
|
Package cliptyfs cmd/skywire-cli/commands/ptyfs/identity_linux.go c4-vis-cli destination parsing + identity loading helpers used by the linux mount path. |
|
pv
Package pv cmd/skywire-cli/commands/pv/pv.go c4-vis-cli
|
Package pv cmd/skywire-cli/commands/pv/pv.go c4-vis-cli |
|
resolver
Package cliresolver cmd/skywire-cli/commands/resolver/ca.go c4-vis-cli
|
Package cliresolver cmd/skywire-cli/commands/resolver/ca.go c4-vis-cli |
|
reward
Package clireward cmd/skywire-cli/commands/reward/lookup.go c4-vis-cli
|
Package clireward cmd/skywire-cli/commands/reward/lookup.go c4-vis-cli |
|
rewards
Package clirewards cmd/skywire-cli/commands/rewards/calc.go c4-vis-cli
|
Package clirewards cmd/skywire-cli/commands/rewards/calc.go c4-vis-cli |
|
rewards/server
Package clirewardsserver cmd/skywire-cli/commands/rewards/server/cmd.go c4-vis-cli
|
Package clirewardsserver cmd/skywire-cli/commands/rewards/server/cmd.go c4-vis-cli |
|
rewards/tgbot
Package clirewardstgbot cmd/skywire-cli/commands/rewards/tgbot/tgbot.go c4-vis-cli
|
Package clirewardstgbot cmd/skywire-cli/commands/rewards/tgbot/tgbot.go c4-vis-cli |
|
rg
Package clirg cmd/skywire-cli/commands/rg/rg.go c4-vis-cli
|
Package clirg cmd/skywire-cli/commands/rg/rg.go c4-vis-cli |
|
route
Package cliroute cmd/skywire-cli/commands/route/calc.go c4-vis-cli
|
Package cliroute cmd/skywire-cli/commands/route/calc.go c4-vis-cli |
|
rpc
Package clirpc cmd/skywire-cli/commands/rpc/root.go c4-vis-cli
|
Package clirpc cmd/skywire-cli/commands/rpc/root.go c4-vis-cli |
|
sd
Package clisd cmd/skywire-cli/commands/sd/root.go c4-vis-cli
|
Package clisd cmd/skywire-cli/commands/sd/root.go c4-vis-cli |
|
serve
Package cliserve cmd/skywire-cli/commands/serve/serve.go c4-vis-cli
|
Package cliserve cmd/skywire-cli/commands/serve/serve.go c4-vis-cli |
|
skychat
Package cliskychat cmd/skywire-cli/commands/skychat/chat.go c4-vis-cli interactive split-pane chat against the local skychat app's HTTP/SSE interface.
|
Package cliskychat cmd/skywire-cli/commands/skychat/chat.go c4-vis-cli interactive split-pane chat against the local skychat app's HTTP/SSE interface. |
|
skycoin
Package cliskycoin cmd/skywire-cli/commands/skycoin/daemon.go c4-vis-cli
|
Package cliskycoin cmd/skywire-cli/commands/skycoin/daemon.go c4-vis-cli |
|
skynet
Package skynet cmd/skywire-cli/commands/skynet/port.go c4-vis-cli
|
Package skynet cmd/skywire-cli/commands/skynet/port.go c4-vis-cli |
|
ssh
Package clissh cmd/skywire-cli/commands/ssh/ssh.go c4-vis-cli the OpenSSH-equivalent client over skywire identity.
|
Package clissh cmd/skywire-cli/commands/ssh/ssh.go c4-vis-cli the OpenSSH-equivalent client over skywire identity. |
|
sshd
Package clisshd cmd/skywire-cli/commands/sshd/sshd.go c4-vis-cli sshd`, the OpenSSH-equivalent server over skywire identity.
|
Package clisshd cmd/skywire-cli/commands/sshd/sshd.go c4-vis-cli sshd`, the OpenSSH-equivalent server over skywire identity. |
|
survey
Package clisurvey cmd/skywire-cli/commands/survey/root.go c4-vis-cli
|
Package clisurvey cmd/skywire-cli/commands/survey/root.go c4-vis-cli |
|
svc
Package clisvc cmd/skywire-cli/commands/svc/ar_check.go c4-vis-cli
|
Package clisvc cmd/skywire-cli/commands/svc/ar_check.go c4-vis-cli |
|
tp
Package clitp cmd/skywire-cli/commands/tp/tp-add-edge.go c4-vis-cli
|
Package clitp cmd/skywire-cli/commands/tp/tp-add-edge.go c4-vis-cli |
|
tps
Package clitps cmd/skywire-cli/commands/tps/tps.go c4-vis-cli
|
Package clitps cmd/skywire-cli/commands/tps/tps.go c4-vis-cli |
|
ut
Package cliut cmd/skywire-cli/commands/ut/mdisc.go c4-vis-cli
|
Package cliut cmd/skywire-cli/commands/ut/mdisc.go c4-vis-cli |
|
util
Package cliutil cmd/skywire-cli/commands/util/foreach.go c4-vis-cli foreach` — run a templated shell command against a list of public keys (or arbitrary tokens) in parallel and print collated output with per-target headers.
|
Package cliutil cmd/skywire-cli/commands/util/foreach.go c4-vis-cli foreach` — run a templated shell command against a list of public keys (or arbitrary tokens) in parallel and print collated output with per-target headers. |
|
version
Package cliversion cmd/skywire-cli/commands/version/root.go c4-vis-cli
|
Package cliversion cmd/skywire-cli/commands/version/root.go c4-vis-cli |
|
visor
Package clivisor cmd/skywire-cli/commands/visor/app.go c4-vis-cli
|
Package clivisor cmd/skywire-cli/commands/visor/app.go c4-vis-cli |
|
visor/ping
Package clivisor cmd/skywire-cli/commands/visor/ping/bandwidth.go c4-vis-cli
|
Package clivisor cmd/skywire-cli/commands/visor/ping/bandwidth.go c4-vis-cli |
|
vpn
Package clivpn cmd/skywire-cli/commands/vpn/root.go c4-vis-cli
|
Package clivpn cmd/skywire-cli/commands/vpn/root.go c4-vis-cli |
|
wisp
Package cliwisp cmd/skywire-cli/commands/wisp/client.go c4-vis-cli
|
Package cliwisp cmd/skywire-cli/commands/wisp/client.go c4-vis-cli |
Click to show internal directories.
Click to hide internal directories.