Skip to content

Commit

Permalink
Add Section about 'velocitas init' with package parameter
Browse files Browse the repository at this point in the history
  • Loading branch information
wba2hi committed Apr 29, 2024
1 parent dc2f75e commit 3f8cbb1
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion content/en/docs/concepts/lifecycle_management/velocitas_cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Config 'src' for interface 'vehicle-signal-interface': URI or path to VSS json (

### velocitas init

Download packages configured in your `.velocitas.json` to [VELOCITAS_HOME](https://github.com/eclipse-velocitas/cli/blob/main/README.md#changing-default-velocitas_home-directory)
#### Download packages configured in your `.velocitas.json` to [VELOCITAS_HOME](https://github.com/eclipse-velocitas/cli/blob/main/README.md#changing-default-velocitas_home-directory)

```bash
vscode ➜ /workspaces/vehicle-app-python-template (main) $ velocitas init
Expand All @@ -57,6 +57,19 @@ Running 'install-deps'
...
```

#### Dynamically initialize packages NOT configured in `.velocitas.json`

Packages which are not part of .velocitas.json can easily be initialized using the _package parameter_ `-p / --package` and the _specifier parameter_ `-s / --specifier`. The _specifier parameter_ can be either a git tag or a git hash. If the _specifier parameter_ is omitted the latest version of the specified package will be used automatically. After initialisation the package and it's resolved version will be written to `.velocitas.json`. If the package is already part of `.velocitas.json`, however the version is different the version will be automatically adapted to reflect the specified version.

```bash
vscode ➜ /workspaces/vehicle-app-python-template (main) $ velocitas init -p devenv-runtimes -s v3.0.0
Initializing Velocitas packages ...
... Package 'devenv-runtimes:v3.0.0' added to .velocitas.json
... Downloading package: 'devenv-runtimes:v3.0.0'
... > Running post init hook for ...
...
```

### velocitas sync

If any package provides files they will be synchronized into your repository.
Expand Down

0 comments on commit 3f8cbb1

Please sign in to comment.