bore_cli/lib.rs
1//! A modern, simple TCP tunnel in Rust that exposes local ports to a remote
2//! server, bypassing standard NAT connection firewalls.
3//!
4//! This is the library crate documentation. If you're looking for usage
5//! information about the binary, see the command below.
6//!
7//! ```shell
8//! $ bore help
9//! ```
10//!
11//! There are two components to the crate, offering implementations of the
12//! server network daemon and client local forwarding proxy. Both are public
13//! members and can be run programmatically with a Tokio 1.0 runtime.
14
15#![forbid(unsafe_code)]
16#![warn(missing_docs)]
17
18pub mod auth;
19pub mod client;
20pub mod server;
21pub mod shared;