Skip to content

Improved installation instructions #138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 22, 2025
Merged

Improved installation instructions #138

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,22 @@ Commands for provisioning hosts in the cloud (AWS or GCP) are also available.

## Installation

Install with pip3:
Install with [pipx](https://pipx.pypa.io/):

```bash
pipx install cf-remote
```
$ pip3 install cf-remote

Or pip3:

```bash
pip3 install cf-remote
```

Or pip:

```bash
pip install cf-remote
```

## Examples
Expand Down Expand Up @@ -109,7 +121,7 @@ Waiting for VMs to get IP addresses..........DONE
Details about the spawned VMs can be found in /home/olehermanse/.cfengine/cf-remote/cloud_state.json
```

You can now install nightlies, and use the ```--demo``` to make testing easier (**Not** secure for production use).
You can now install nightlies, and use the `--demo` to make testing easier (**Not** secure for production use).
Referring to the group names set by spawn, makes the commands a lot shorter and easier to script:

```
Expand Down