From f4bb0329bcdeae7c2aeec4ce6195189048fcf4e2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bartal=20L=C3=A6arsson?= Date: Sun, 2 Mar 2025 21:32:16 +0000 Subject: [PATCH] update readme --- README.md | 4 ++++ cli/README.md | 11 ++++++++++- 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index becbaf9..01d1214 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,10 @@ The CLI tool provides a user-friendly interface for managing your environments: # Install CLI tool ./cli/install.sh +# The installer adds the binary to ~/.local/bin +# Make sure this is in your PATH +export PATH="$PATH:$HOME/.local/bin" + # Run the tool provision ``` diff --git a/cli/README.md b/cli/README.md index 6970ee8..6cbd56c 100644 --- a/cli/README.md +++ b/cli/README.md @@ -10,18 +10,27 @@ A user-friendly CLI tool for provisioning and managing infrastructure components ```bash ./install.sh + +# Make sure ~/.local/bin is in your PATH +export PATH="$PATH:$HOME/.local/bin" ``` -This installs the CLI tool to `~/.local/bin` and provides PATH configuration instructions if needed. +This installs the CLI tool to `~/.local/bin`. You may need to add this directory to your PATH if it's not already there. To make this change permanent, add the export line to your `~/.bashrc` or `~/.profile`. ### Manual Install Find the appropriate binary for your platform in the `bin` directory: ```bash +# Create ~/.local/bin directory if it doesn't exist +mkdir -p ~/.local/bin + # Example for Linux/AMD64 cp bin/linux_amd64/provision ~/.local/bin/ chmod +x ~/.local/bin/provision + +# Add to PATH if needed +export PATH="$PATH:$HOME/.local/bin" ``` Available binaries: