ctun v0.1.0

Usage (CLI)

Globally run tunnel with npx:

npx ctun@latest --url http://localhost:3000

Use npx ctun --help for more usage info.

Result

Usage (API)

Install package:

# npm
npm install ctun

# yarn
yarn add ctun

# pnpm
pnpm install ctun

Import:

// ESM
import { startTunnel } from "ctun";

Start tunnel:

const tunnel = await startTunnel({ port: 3000 });

Options

url

• Default: {protocol}://{hostname}:{port}

The local server URL to tunnel.

port

• Default: 3000

The local server PORT (only effective if url is not provided).

hostname

• Default: localhost

The local server hostname (only effective if url is not provided).

protocol

• Default: http

The local server protocol (only effective if url is not provided).

verifyTLS

• Default: false

Verify local server TLS certificate.

License

Cloudflared integration based on a fork of JacobLinCool/node-cloudflared

Your installation of cloudflared software constitutes a symbol of your signature indicating that you accept the terms of the Cloudflare License, Terms and Privacy Policy.