From a31452fba15d37da8ba0c5d15036e6e77f8f1a9a Mon Sep 17 00:00:00 2001 From: Stavros Date: Tue, 17 Sep 2024 22:13:28 +0300 Subject: [PATCH] chore: update readme --- README.md | 27 +++++++++++++-------------- cleanup.sh | 1 + 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 59f096f..908f423 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,37 @@ ## Runtipi CLI Go -> Warning ⚠️: This is now under the runtipi organization and it will be maintained by the whole runtipi team. - A reimplementation of the [Runtipi CLI](https://github.com/runtipi/cli) in the Go programming language with some imporevements and new features. -> Warning ⚠️: This is in early stages of development, I am trying to make this better than the official CLI and maybe just maybe make Nicolas use this versison +> Warning ⚠️: This project is built and maintained by volunteers. There is no guarantee of support or security when you use it. While the system is considered stable, it is still in active development and may contain bugs. + +> Info ℹ️: Runtipi CLI Go is written in 100% Go, if you would like to help check out the issues section or our Discord server! +> ### Why? -Why am I building this? Two reasons, firstly I don't like rust and I think its a bad choice for the CLI so I want to build -something better. Secondly, I just want to learn Go. +We are just having fun with [Nicolas](https://github.com/meienberger) learning new languages and we thing Go is a better option for our CLI. ## Features -The Runtipi Go CLI has all the official Runtipi CLI features and the following extra ones: +The Runtipi Go CLI has all the official Runtipi CLI features and the following ones: - List app backups command (`./runtipi-cli app list-backups`) - Healthcheck command using the worker API - System readings from the worker API -- Backup command\* +- Backup command - List backups command (for runtipi) - Neofetch command (easter egg) - Automatic backup of the CLI before update - -\*I will not add a restore command due to the complexity of explaining users how to use it +- Increased timeout on app commands to 5 and 15 minutes (for updates) to make sure it is the same as the dashboard timeout ### Installation To install the CLI you need to follow 4 simple steps. -1. Download the latest version matching your system's arch from the [releases](https://github.com/steveiliop56/runtipi-cli-go/releases/) page. +1. Download the latest version matching your system's arch from the [releases](https://github.com/runtipi/runtipi-cli-go/releases/) page. 2. Put the CLI in your `runtipi` folder and rename it to `runtipi-cli-go`. 3. Make it executable `chmod +x runtipi-cli-go` 4. Start using it `sudo ./runtipi-cli-go start` @@ -44,7 +43,7 @@ To build the CLI you need to have go installed and then run these commands: Firstly clone the repository: ```bash -git clone https://github.com/steveiliop56/runtipi-cli-go +git clone https://github.com/runtipi/runtipi-cli-go cd runtipi-cli-go/ ``` @@ -60,6 +59,8 @@ Build: go build ``` +> Note 🗒️: You can get the CLI down to around 8mb using the `go build -ldflags '-w -s'` command. + You should have the CLI named `runtipi-cli-go`. ### License @@ -74,6 +75,4 @@ If you like you can contribute to this project by creating a pull request. Any h Thank's a lot to: -- [Runtipi CLI](https://github.com/runtipi/cli) because this code is msotly a translation right now -- [Carbon](https://carbon.sh) for the cool CLI screenshot -- [Nicolas](https://github.com/meienberger) because well...he made Runtipi. +- [Carbon](https://carbon.sh) for the cool CLI screenshot \ No newline at end of file diff --git a/cleanup.sh b/cleanup.sh index 45c0cc9..6566d7f 100755 --- a/cleanup.sh +++ b/cleanup.sh @@ -22,4 +22,5 @@ rm -rf .env # Test Files # /internal/constants/assets/RUNTIPI_VERSION # /internal/constants/assets/CLI_VERSION +# /internal/constants/assets/VERSION # /.env.local \ No newline at end of file