From 566577cf4e44a3f372f3364b212daf98c3aaf4be Mon Sep 17 00:00:00 2001 From: Serhii Korchynskyi Date: Wed, 6 Sep 2023 14:08:31 +0200 Subject: [PATCH] Update README.md (#161) * Update README.md Correct a description as for a velocitas-cli installation * Update README.md Fix review findings * Update README.md Generalized invocation command * Update README.md Fix review findings * Update README.md Co-authored-by: dennismeister93 * Update README.md Fix linter --------- Co-authored-by: dennismeister93 --- README.md | 25 ++++++++----------------- 1 file changed, 8 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 38afec48..e424d8c2 100644 --- a/README.md +++ b/README.md @@ -316,31 +316,22 @@ _See code: [src/commands/upgrade/index.ts](src/commands/upgrade/index.ts)_ # Installation -There are 2 ways to get ahold of the CLI. - -## NPM - ---- - **Prerequisites** * NodeJS >= 18 * NPM * Linux environment (others may work, but are untested) ---- +## Obtaining prebuilt binaries -**Steps** -1. Clone this repo -2. cd into the cloned repo -3. Run the following command: +You can obtain prebuilt binaries of the CLI which have no dependency to NodeJS. These can be found [here](https://github.com/eclipse-velocitas/cli/releases). +Currently we are supporting only linux `arm64` and `x64` architecture. +Velocitas CLI is already pre-intalled within our [devcontainer-base-image](https://github.com/eclipse-velocitas/devcontainer-base-images). -```sh-session -$ npm install -g velocitas-cli +If you need to install it on custom setup, please use follow, where `` any released tag version, e.g. `v0.5.5`, and `` - architecture type, e.g. `arm64` or `x64`: +``` +curl -L https://github.com/eclipse-velocitas/cli/releases/download//velocitas-linux- -o /usr/bin/velocitas +chmod -x /usr/bin/velocitas ``` - -## Obtaining prebuilt binaries - -In case you do not want to install NodeJS on your system, you can obtain prebuilt binaries of the CLI which have no dependency to NodeJS. These can be found [here](https://github.com/eclipse-velocitas/cli/releases). # Configuration ## Changing default VELOCITAS_HOME directory