CLI Reference
This is the CLI reference for jvln, the command line tool for establishing tunnel connections with the server. Run jvln --help at any time to view this reference in the terminal.
For installation instructions or to find out how to open your first tunnel, see Getting Started.
Starts the Jvln daemon. The daemon is responsible for proxying traffic and managing tunnel connections with the server.
jvln armOptions
Section titled “Options”| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--log-level |
LogVerbosityLevel |
No | info | Configure verbose output for detailed logging. (info|debug|trace) |
disarm
Section titled “disarm”Stops the Jvln daemon. By stopping the daemon, all active tunnel connections will be closed, as the connection with the server will be lost. However, tunnel connections will not be forgotten, so they will be re-established the next time the daemon is started.
jvln disarmOptions
Section titled “Options”| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--log-level |
LogVerbosityLevel |
No | info | Configure verbose output for detailed logging. (info|debug|trace) |
retrieve
Section titled “retrieve”Operations for terminating tunnel connections.
retrieve tcp
Section titled “retrieve tcp”Closes and forgets an existing TCP tunnel. The server will no longer forward TCP traffic to the port specified.
jvln retrieve tcp --server <ServerAddress> --port <ushort>Options
Section titled “Options”| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
-s --server |
ServerAddress |
Yes | — | Jvln server to connect with. |
-p --port |
ushort |
Yes | — | Local port that requests are being be forwarded to. |
--log-level |
LogVerbosityLevel |
No | info | Configure verbose output for detailed logging. (info|debug|trace) |
Examples
Section titled “Examples”# closes a tunnel available at jvln.sh that forwards traffic to local tcp port 3000jvln retrieve tcp --server jvln.sh --port 3000status
Section titled “status”Retrives the current status of the Jvln daemon.
jvln statusOptions
Section titled “Options”| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--log-level |
LogVerbosityLevel |
No | info | Configure verbose output for detailed logging. (info|debug|trace) |
target
Section titled “target”Establishes a secure connection with a Jvln server.
jvln target --server <ServerAddress> [--code <string>]Options
Section titled “Options”| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
-s --server |
ServerAddress |
Yes | — | Jvln server to connect with. |
-c --code |
string |
No | — | One-time invitation code generated by the server. |
--log-level |
LogVerbosityLevel |
No | info | Configure verbose output for detailed logging. (info|debug|trace) |
Examples
Section titled “Examples”# connects to jvln.shjvln target --server jvln.sh --code AABBCCOperations for establishing tunnel connections.
throw tcp
Section titled “throw tcp”Creates a tunnel for forwarding TCP connections. The server will generate a unique identifier for the tunnel and make it available for TCP connections at that subdomain.
jvln throw tcp --server <ServerAddress> --port <ushort>Options
Section titled “Options”| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
-s --server |
ServerAddress |
Yes | — | Jvln server to connect with. |
-p --port |
ushort |
Yes | — | Local port requests should be forwarded to. |
--log-level |
LogVerbosityLevel |
No | info | Configure verbose output for detailed logging. (info|debug|trace) |
Examples
Section titled “Examples”# opens a tunnel available at jvln.sh, forwarding traffic to local tcp port 3000jvln throw tcp --server jvln.sh --port 3000