Technical Documentation

Complete guide to installing and using Sixter Secure Tunnel

1 Installation Setup

Follow these simple steps to install Sixter Tunnel on your system. The installation process is straightforward and takes only a few minutes.

📥

Step 1: Download the Installer

Download the Sixter installer for your operating system. The installer is lightweight and includes all necessary dependencies.

🖼️ Replace with your installer screenshot

Screenshot: Download page or installer file

⚙️

Step 2: Run the Installer

Double-click the downloaded file to launch the installation wizard. Follow the on-screen instructions to complete the setup.

🖼️ Replace with installer welcome screen

Screenshot: Inno Setup installer welcome screen

📂

Step 3: Choose Installation Directory

Select the installation directory or use the default location. The installer will automatically configure system PATH variables.

🖼️ Replace with directory selection screen

Screenshot: Directory selection dialog

✅

Step 4: Complete Installation

Wait for the installation to complete. Once finished, you can start using Sixter from any terminal or command prompt.

🖼️ Replace with completion screen

Screenshot: Installation complete confirmation

💡 System Requirements
Sixter supports Windows 10/11, macOS 10.15+, and major Linux distributions. Requires at least 50MB of free disk space and an active internet connection.

2 How to Use

After installation, using Sixter is incredibly simple. Open your terminal or command prompt and run the following command:

Terminal / Command Prompt 
sixter --subdomain <your subdomain name> --port <your project port>
⚠️ Important Note
Make sure your local development server is running on the specified port before creating the tunnel. The subdomain name must be unique and available.

3 Usage Examples

Here are some common use cases to help you get started quickly with Sixter Tunnel:

🌐 Basic Web Application

Expose a local web server running on port 3000 with a custom subdomain:

Terminal 
sixter --subdomain myapp --port 3000
This creates a secure tunnel at myapp.sixter.in pointing to localhost:3000
🔌 API Development

Share your local API server for testing with external services:

Terminal 
sixter --subdomain my-api --port 8080
Your API will be accessible at my-api.sixter.in for webhook testing and integration
⚛️ React Development Server

Share your React app during development for client demos:

Terminal 
sixter --subdomain react-demo --port 5173
Vite's default port 5173 is now accessible at react-demo.sixter.in
🎨 Design Preview

Share your design work with team members or clients:

Terminal 
sixter --subdomain design-preview --port 4000
Share design-preview.sixter.in with stakeholders for instant feedback
🚀 Pro Tips
• Use descriptive subdomain names that reflect your project
• Keep the tunnel running while you need external access
• Use different subdomains for different projects or environments
• Press Ctrl+C in the terminal to stop the tunnel