diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index 239df34..f42bf63 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -16,9 +16,10 @@ curl -fsSL https://luca.tools/install.sh | bash The installer: 1. Detects your OS and architecture (macOS arm64/x86_64, Linux x86_64/arm64) 2. Downloads the appropriate Luca binary from GitHub Releases -3. Installs it to `/usr/local/bin/luca` -4. Installs the shell hook to `~/.luca/shell_hook.sh` and sources it from `~/.zshrc` or `~/.bashrc` -5. Optionally installs the git post-checkout hook if you're inside a git repository +3. Installs it to `~/.local/bin/luca` (no `sudo` required); set `INSTALL_DIR=/usr/local/bin` before running the installer to opt into the old system-wide location +4. If `~/.local/bin` isn't already on your `PATH`, appends an `export PATH` line to your shell RC file (`~/.zshrc` or `~/.bashrc`) +5. Installs the shell hook to `~/.luca/shell_hook.sh` and sources it from `~/.zshrc` or `~/.bashrc` +6. Optionally installs the git post-checkout hook if you're inside a git repository ## Pinning the CLI Version @@ -39,7 +40,7 @@ Requires Swift 5.7+ and macOS 13+ or Linux. git clone https://github.com/LucaTools/Luca.git cd Luca swift build -c release -cp .build/release/luca /usr/local/bin/luca +cp .build/release/luca ~/.local/bin/luca ``` On Linux, build a static binary that doesn't require the Swift runtime: @@ -68,4 +69,4 @@ Expected output: the list of available subcommands (`install`, `run`, `init`, `u curl -fsSL https://luca.tools/uninstall.sh | bash ``` -This removes the `luca` binary from `/usr/local/bin`, the shell hook from `~/.luca/`, and the source line from your shell RC file. +This removes the `luca` binary from `~/.local/bin` (or `INSTALL_DIR` if you customized it), the PATH export line it added, the shell hook from `~/.luca/`, and the source line from your shell RC file.