Skip to content

Commit

Permalink
Update README.md (#161)
Browse files Browse the repository at this point in the history
* 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 <dennis.meister@bosch.com>

* Update README.md

Fix linter

---------

Co-authored-by: dennismeister93 <dennis.meister@bosch.com>
  • Loading branch information
kse3hi and dennismeister93 authored Sep 6, 2023
1 parent ed7f69c commit 566577c
Showing 1 changed file with 8 additions and 17 deletions.
25 changes: 8 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<version_tag>` any released tag version, e.g. `v0.5.5`, and `<arch>` - architecture type, e.g. `arm64` or `x64`:
```
curl -L https://github.com/eclipse-velocitas/cli/releases/download/<version_tag>/velocitas-linux-<arch> -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
Expand Down

0 comments on commit 566577c

Please sign in to comment.