Skip to content

Commit

Permalink
Merge pull request #211 from baloise/setupdoc
Browse files Browse the repository at this point in the history
doc: update setup with poetry
  • Loading branch information
christiansiegel committed Nov 5, 2023
2 parents 5bb7d60 + 5d96018 commit d9c4dce
Showing 1 changed file with 28 additions and 1 deletion.
29 changes: 28 additions & 1 deletion docs/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,34 @@ Start the CLI and the print the help page with:
docker run --rm -it baloise/gitopscli --help
```

## From Source
## From Source With Virtualenv

Use this for developement and if you want to prevent dependency clashes with other programs in a user installation.

Clone the repository and install the GitOps CLI on your machine:
```bash
git clone https://github.com/baloise/gitopscli.git
cd gitopscli/
poetry install
```
You can now use it from the command line:
```bash
poetry run gitopscli --help
```
If you don't need the CLI anymore, you can uninstall it with
```bash
poetry env remove --all
```

Note: if your poetry is not up to date to handle the files you can use a locally updated version.
Execute the following command in your cloned gitopscli directory to use an updated poetry without changing your system installation:
```bash
python3 -m venv .venv
source .venv/bin/activate
pip3 install poetry # installs it in the venv
```

## From Source Into User Installation

Clone the repository and install the GitOps CLI on your machine:
```bash
Expand Down

0 comments on commit d9c4dce

Please sign in to comment.