headshed/mvk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Enhance development environment guide by adding pre-flight checks and updating required executables for Windows users

Browse source
This commit is contained in:
jon brookes 2025-08-16 18:03:53 +01:00
parent 467a11a2c1
commit 242d915452
1 changed files with 14 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

16
src/content/docs/guides/dev-env.md
View file

@ -3,6 +3,8 @@ title: Local Development Environment
description: A guide to checking a local environment. description: A guide to checking a local environment.
--- ---
## Pre Flight Checks
Run `dev-pre-flight-checks.sh` command line tool with Run `dev-pre-flight-checks.sh` command line tool with
```bash ```bash
@ -13,9 +15,19 @@ Alternatively, download https://codeberg.org/headshed/infctl-cli/raw/branch/main
the following executables are checked to be in your `$PATH`: the following executables are checked to be in your `$PATH`:
"infctl" "pwgen" "kubectl" "k3d" "helm" "jq" "docker" "infctl" "pwgen" "kubectl" "k3d" "helm" "jq" "docker" "vagrant" "git"
if any of these are missing, a development environment cannot be created. if any of these are missing, an MVK development environment may fail.
### Note for windows users
Linux and Mac already have `bash` and often `git` installed as part of a default developer environment, however Windows may not, so for MVK, we can use [Git Bash](https://git-scm.com/downloads), so check you have this installed on Windows if not already.
Windows will need `jq` to be installed by [downloading](https://jqlang.org/download/) it or installing with `winget install jqlang.jq.`
Use Git Bash from here on to run `infctl` commands as they will require for there to be a bash shell to run any of its plugins.
## Install Pre-Requisites
`infctl` - see [quick start](/guides/quick-start/) `infctl` - see [quick start](/guides/quick-start/)