⚠️ Runtipi CLI is built and maintained by volunteers. There is no guarantee of support or security when you use Runtipi CLI. While the system is considered stable, it is still in active development and may contain bugs.
Runtipi CLI is an updated version of the old typescript based CLI that many of you used. The old CLI was slow, big in size and insecure. So we are happy to present you the all new Rust CLI. It is just a few killobytes, extremely fast and very secure. With the new CLI we don't need to depend on a node js runtime so the speed is faster than ever! To get started follow the instructions bellow.
If you already have a runtipi instance you can just stop it delete the old cli and download our new one from the release page here.
⚠️ The CLI version and tipi version should match in order for the installation to work. If you try to use a different cli and tipi version you may encouter issues.
If you like to you can build the CLI locally in your own machine. To do that you must have cargo and rust installed on your system. Then you can just clone the repository with:
git clone --depth 1 https://github.com/runtipi/cliThen you can just build the CLI with:
cargo buildThe CLI will be in the target/debug/ folder named runtipi-cli
Rust is a new language for the runtipi team. If you have any rust knowledge we are happy to accept contributions and your name will be added in the "Contributors" section below.
Runtipi CLI is licensed under the GNU General Public License v3.0. TL;DR — You may copy, distribute and modify the software as long as you track changes/dates in source files. Any modifications to or software including (via compiler) GPL-licensed code must also be made available under the GPL along with build & install instructions.
- Carbon - Thanks for providing the Runtipi CLI screenshot.
Thanks goes to these wonderful people (emoji key):
 Nicolas Meienberger 💻 |
 Stavros 💻 📖 |
 hex-developer 💻 |
 Jonathan Virga 💻 |
Did you contribute and want to see your name listed in the README? Write a comment here This project follows the all-contributors specification. Contributions of any kind welcome!