Skip to content

Commit 5d96018

Browse files
committed
doc: update setup with poetry
1 parent 5bb7d60 commit 5d96018

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

docs/setup.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,34 @@ Start the CLI and the print the help page with:
1313
docker run --rm -it baloise/gitopscli --help
1414
```
1515

16-
## From Source
16+
## From Source With Virtualenv
17+
18+
Use this for developement and if you want to prevent dependency clashes with other programs in a user installation.
19+
20+
Clone the repository and install the GitOps CLI on your machine:
21+
```bash
22+
git clone https://github.com/baloise/gitopscli.git
23+
cd gitopscli/
24+
poetry install
25+
```
26+
You can now use it from the command line:
27+
```bash
28+
poetry run gitopscli --help
29+
```
30+
If you don't need the CLI anymore, you can uninstall it with
31+
```bash
32+
poetry env remove --all
33+
```
34+
35+
Note: if your poetry is not up to date to handle the files you can use a locally updated version.
36+
Execute the following command in your cloned gitopscli directory to use an updated poetry without changing your system installation:
37+
```bash
38+
python3 -m venv .venv
39+
source .venv/bin/activate
40+
pip3 install poetry # installs it in the venv
41+
```
42+
43+
## From Source Into User Installation
1744

1845
Clone the repository and install the GitOps CLI on your machine:
1946
```bash

0 commit comments

Comments
 (0)