jumpgate
  1. Docs
  2. The TUI
  3. The guide

The guide

Read this guide inside the TUI with :help.

How you got here: Desktop app Terminal only: TUI and CLI One server for everything Screens Keys

Show previous steps 5
Install 2
  1. Desktop app

    Download the desktop app for your OS and open it.

    The macOS zip holds Jumpgate.app and Jumpgate Terminal.app; Windows has jumpgate-tray.exe and jumpgate.exe; Linux has install.sh. Every download carries both Linux agents.

    Show image
    The app panel's Home tab: the gateway running two networks.
    Illustration from the jumpgate.app demo, with made-up boxes; not a screenshot of the app.
  2. Terminal only: TUI and CLI

    The jumpgate binary alone, for servers and scripts.

    The jumpgate_<os>_<arch> archives hold one binary with the TUI, the CLI and the server. Run jumpgate in a terminal to open the TUI.

    Show image
    The Fleet screen: every box with its link, network, sync, lag, peers, disk and firewall.
    The TUI, from its test snapshot; empty rows removed.
Getting started 1
  1. One server for everything

    The app, TUI and CLI share one background server.

    Whichever starts first runs the server; quitting the TUI leaves it running and jumpgate stop ends it.

The TUI 2
  1. Screens

    The six screens: Fleet, Hosts, Signers, Gateways, Jobs, Settings.

    1 to 6 switch screens; Enter on a box opens its tabs, from Overview to Services.

    Show image
    The Fleet screen: every box with its link, network, sync, lag, peers, disk and firewall.
    The TUI, from its test snapshot; empty rows removed.
  2. Keys

    The keys that work on every screen.

    Arrows or hjkl move, Enter opens, Esc goes back, : takes a command and ? lists every key for the screen you are on.

    Show image
    The help screen: the keys that work everywhere, then the keys for the current screen.
    The TUI, from its test snapshot; empty rows removed.

:help lists the guide's topics and :help TOPIC opens one, such as :help jobs. On a page, j and k scroll, space and b page, g and G go to the top and bottom, h and l turn to the previous and next topic, and esc goes back to the topics.