holesail
DownloadGithubBlog
  • 👋Welcome to the web of Peers
  • Overview
    • ⛵What can holesail do
    • ✨Our Features
  • Installation Guide
    • 📪Install through npm (Recommended)
    • 🪟Holesail executable (Windows, Linux, Mac)
    • 🍎Holesail Go (Mac & iPhone)
    • 📱Holesail Go Android
  • USAGE GUIDE
    • 😙Overview
    • 🖥️Set a port live
    • 🤝Connect to someone
    • Run in background
    • 🗃️Filemanager
  • Terminology
    • Connection String
    • Private vs Public connection string
Powered by GitBook
On this page

Was this helpful?

  1. USAGE GUIDE

Run in background

Holesail can run connections in the background, persist them when the terminal closes and sync them across devices (in future).

To get a quick overview of all the commands, run:

holesail --help
Parameter
Purpose

--background

Run connection in the background.

--name

A unique name to identify the session.

--logs <session-name>

View logs for a connection, includes connection details.

--list

List all Holesail sessions.

--delete <session-name>

Delete a Holesail session.

--stop <session-name>

Stops a running session.

--start <session-name>

Starts a stopped session.

Examples

To Set a port live :

holesail --live 5000 --host 0.0.0.0 --background

Connect to a holesail connection:

holesail  2351b686a7de6469d11b721b68b04b12242cb8e0beb84a2f0855c7c0200aedd7 --port 3434 --background

Give our session a custom name:

holesail --live 3434 --name raspberrypi

View logs of a session:

holesail --logs holesail-raspberrypi

Delete a session:

holesail --delete holesail-raspberrypi

Delete all sessions:

holesail --delete all

Stop a holesail session:

holesail --stop raspberrypi

Note: If you did not set a custom connection string, stopping and restarting a session will reset it's connection string.

Start a stopped session:

holesail --start Raspberrypi
PreviousConnect to someoneNextFilemanager

Last updated 3 months ago

Was this helpful?