Skip to content

Quick start

Terminal window
laraport

The first screen lists your servers. Without a config file there is one: Local, the Docker on your machine.

If you already reach your servers with ssh, press i on the server list to import them from ~/.ssh/config. See Importing.

To add one by hand:

  1. Press a on the server list.
  2. Fill in the name, host, user and, if needed, the key file. Leave the key empty to use ssh-agent and your default keys.
  3. Press ctrl+t to test the connection. laraport connects and runs docker version.
  4. Press ctrl+s to save. The server is written to ~/.config/laraport/config.yaml.

Press enter on the server. The container list shows every container, grouped by project, with its state, ports and live CPU and memory.

From the list you can already act on the selected container:

Key Action
enter Open the container screen
l Follow its logs (on a group header: the logs of the whole group)
t Open a shell in it
f Browse its files
/ Filter the list

Press enter on a container. On top you see its summary; below it, tabs with everything you can do in it. A Laravel container gets a Laravel tab with Artisan, Tinker, Queues, Schedule and Environment.

  • ? shows every key of the current screen.
  • ctrl+k opens the command palette: type a few letters of what you want (log, tinker, dump) and press enter.
  • ctrl+p jumps to a container you opened lately, or to any server, from anywhere.
  • esc goes back.

Next: the interface, or configure your containers with display names and favourites.