Skip to main content

command

Holesail commands (parameters) are straightforward and divided into three categories for easy understanding.

  1. Information Commands
  2. Server Commands
  3. Client Commands

Information Commands​

  1. --help : Displays the default help message containing all available commands.
  2. --version : Displays the version of the holesail client running.

Server Commands​

  1. --live : Start listening for client communication on the specific port; expects an integer PORT.
$ holesail --live 5000
  1. --host : Listen to a specific address. By default, it listens for connections on 127.0.0.1, but you can switch it to any host accessible from your local machine. Use 0.0.0.0 if you use a jump server or apache2/nginx and want to listen to all addresses.
tip

By default, holesail listens on host 127.0.0.1. Ensure you are listening on the correct host that your service is running on with the --host parameter.

  1. --connector : Set a specific connector to share with your peers easily or reuse the same connection key again and again. Make sure your connector is strong.
$ holesail --live 5000 --host 127.0.0.1 --connector "My lovely secure connection"

Client Commands​

  1. holesail connector : To quickly start a connection, type the connector generated through the server commands above.
$ holesail "My lovely secure connection"

This will connect you with the peer on the other end; the default port is 8989, and the host is 127.0.0.1.

  1. holesail --connector : Same as passing the connector directly as the first parameter.
$ holesail --connector "My lovely secure connection"
  1. --host : Connect on a specific address. By default, it listens for connections on 127.0.0.1, but you can switch it to any host accessible from your local machine.
  2. --port : Specify the port you want to use for connecting. For example if you want to access your server on localhost:3434 you need to run:
$ holesail "My lovely secure connection" --port 3434 --host localhost