Skip to content

Skywire documentation

Skywire is a peer-to-peer privacy-focused networking suite developed by Skycoin. Visors are reachable over two encrypted networks — Skywire (direct routing) and DMSG (relay) — addressed by 33-byte public keys.

This site collects everything an operator or developer needs to run, extend, or understand a Skywire deployment.

Everything ships in one binary. skywire --help is the top of the command tree:

skywire --help — the top-level command tree

And skywire --tui opens an interactive browser of every command and its help text — any command can be run straight from it:

skywire --tui — interactive command browser

The terminal that greets you on the front page of this site is the same binary compiled to WebAssembly, already running skywire --help in your browser — nothing to install. Minimize it to read this page; the >_ terminal pill (bottom right) surfaces it again, and it keeps running while you browse the docs.

Where to start

  • Terminal

    Try skywire without installing anything: the whole binary compiled to WebAssembly behind a browser terminal — the one that greets you on this page. Run skywire autoconfig in it to boot a real visor in the tab, then open its hypervisor UI at http://127.0.0.1:8001 in the nested browser. Anything you start keeps running while you read the docs — the >_ terminal pill brings it back from any page.

  • Guides

    Install, configure, and operate a visor. VPN, SOCKS5, SkyNet port forwarding, manual routing, hypervisor UI.

  • Command Reference

    Every skywire <subcommand> page with flags, usage, examples, and live sample output. Generated from the cobra tree with make doc-gen.

  • Specs

    Protocol-level specifications: transports, packets, routing, setup-node, hypervisor architecture, address-resolver privacy.

  • Rewards

    Eligibility rules for the Skywire reward distribution.

  • Code Graph

    The source as a three-dimensional map — every function and type a node, every call an edge. A way to see the shape of the codebase.

Per-app and per-service docs

The visor-hosted apps — PTY, Skychat, SkyNet, SOCKS5 proxy, and VPN — now have full guides in the Apps section above. The deployment services (transport-discovery, route-finder, service-discovery, address-resolver, uptime-tracker) still live alongside the source under cmd/svc/ and will be integrated here in a follow-up.

Other resources

Regenerating this site

The command-reference subtree (docs/skywire/) is generated from the live cobra tree by the hidden skywire doc subcommand. Regenerate after CLI changes:

make doc-gen

The site itself builds via the Docs GitHub Actions workflow on every push to develop, deploying to the gh-pages branch. For local preview:

make docs-serve