2 releases

0.1.1 Jan 11, 2024
0.1.0 Jul 3, 2023

#60 in #cli-interface

MIT and LGPL-3.0-or-later

20KB
166 lines

torbridge-cli

b b b

torbridge-cli is a command-line interface (CLI) tool written in Rust that allows you to fetch Tor bridges from the BridgeDB and display them in the terminal. It simplifies the process of obtaining Tor bridges for your Tor client configuration.

Installation

Make sure you have Rust and Cargo installed on your system. Then, follow these steps to build and install torbridge-cli:

cargo install torbridge-cli

Or you can clone this Repository and build from there:

  1. Clone the repository:
git clone https://github.com/zolagonano/torbridge-cli.git
  1. Change into the project directory:
cd torbridge-cli
  1. Build the project:
cargo build --release
  1. Optionally, copy the executable to a directory in your system's PATH:
cp target/release/torbridge-cli /usr/local/bin/

Usage

To use torbridge-cli, simply run the executable:

torbridge-cli

The tool will guide you through the process of obtaining Tor bridges. It will display the available transport modes, prompt you to choose a mode, show a captcha image for verification, and request your answer. Finally, it will display the retrieved Tor bridges in the terminal.

Contributing

Contributions are welcome! If you find a bug, have a feature request, or want to contribute code, please open an issue or submit a pull request on the GitHub repository.

When contributing, please follow the existing code style and ensure your changes are well-tested.

Donation

If you find this project helpful and would like to show your appreciation, consider making a donation. Your contributions helps me dedicate more time working on Free and open-source projects ❤️

https://zolagonano.github.io/support

License

This project is licensed under the MIT License.

Dependencies

~17–32MB
~503K SLoC