Skip to main content

Official BoreHook CLI for securely exposing localhost through BoreHook.

Project description

BoreHook CLI

The official command-line interface for BoreHook — securely expose your localhost to the internet, test webhooks, and debug HTTP requests without deploying your application.

Features

  • 🚀 Expose localhost over HTTPS
  • 🔐 Secure authenticated tunnels
  • 🔄 Persistent tunnel management
  • 📡 WebSocket-powered request forwarding
  • ⏱️ Configurable login session duration
  • 💻 Cross-platform (Windows, macOS, Linux)

Installation

Python (PyPI)

pip install borecli

Node.js (npm)

npm install -g borecli

Login

Authenticate your BoreHook account.

bore login

Specify a custom session duration:

bore login --time 30m
bore login --time 8h
bore login --time 7d

If no duration is specified, the default session length is 1 hour.

Supported time units:

Example Meaning
30m 30 Minutes
2h 2 Hours
7d 7 Days

Check Current User

bore whoami

Example:

Logged in as: john@example.com

Logout

bore logout

Connect a Tunnel

Start forwarding traffic to your local application.

bore connect

You'll be prompted to select one of your configured tunnels.

Example:

Available Tunnels

[1] my-api
[2] webhook
[3] development

Select tunnel:

After connecting:

🚀 Tunnel Connected

Tunnel ID: 99c2c16b-e78b-4790-bab8-93865118f91b
Subdomain: webhook
Public URL: https://webhook.borehook.com

Forwarding → http://127.0.0.1:8000

Press Ctrl+C to disconnect.

Commands

Command Description
bore login Authenticate your account
bore connect Connect to a tunnel
bore whoami Display the current logged-in account
bore logout Remove the local session

Examples

Login for one hour (default):

bore login

Login for 15 minutes:

bore login --time 15m

Login for 8 hours:

bore login --time 8h

Connect to a tunnel:

bore connect

Logout:

bore logout

Requirements

  • Windows
  • macOS
  • Linux

Internet connection required.


Documentation

Visit https://borehook.com for documentation, tutorials, and guides.


Support


License

MIT License.


Built with ❤️ by the BoreHook team.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

borecli-1.0.0.tar.gz (71.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

borecli-1.0.0-py3-none-any.whl (74.0 kB view details)

Uploaded Python 3

File details

Details for the file borecli-1.0.0.tar.gz.

File metadata

  • Download URL: borecli-1.0.0.tar.gz
  • Upload date:
  • Size: 71.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.14.2

File hashes

Hashes for borecli-1.0.0.tar.gz
Algorithm Hash digest
SHA256 c054e37016af4718287a7e82153c2a4d5b49416ee12de674f98e46bf0e6dc5a0
MD5 8fddff07fef6fc7a4890e6c2c3435719
BLAKE2b-256 f729c9809cdd78c12f3cd0c24808bbdb5475fef7fef36481fe4676cceb02d572

See more details on using hashes here.

File details

Details for the file borecli-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: borecli-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 74.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.14.2

File hashes

Hashes for borecli-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 be617c7d88741887f794db9fe4148a49c01674aa383eb4b03dd9d988d9e4f4ab
MD5 4105e15056c140163c6ac2d302257b8b
BLAKE2b-256 4799add6a85813f691b7a497f36a6de0ef88af575988d7cc3c42090b3551799f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page