Skip to content

Latest commit

 

History

History
36 lines (25 loc) · 1.19 KB

README.md

File metadata and controls

36 lines (25 loc) · 1.19 KB

Create and manage multiple isolated development environments.

Installation

Workfor requires multipass to be installed on the host.

The entrypoint is the workfor wrapper script, which will start a Python CLI. Hence, make sure Python is installed in your system.

Now, copy .env.example into a new file named .env and customize the settings to your preference.

Make sure everyhing works by running ./workfor -h. If you see the command usage, then you're all set 🚀.

Note: a time saving idea would be to add an alias to the Workfor entrypoint. Something like this: alias wf=/path/to/workfor.

Create an environment

When creating a new environment, the very first thing to do is configuring it.

If the environment is named something, Workfor will look for configuration files inventory.yml.something and inventory.yml, in this order.

You can take a cue from inventory.yml.example.

When ready, you can start and provision the environment with Workfor (try running wf n -h).