Skip to content

Commit b783342

Browse files
committed
fix(install): explain how to add ravel to PATH
Warn after Unix and PowerShell installs when the destination is not discoverable. Document PATH requirements and the direct checkout command for installing the Codex skill.
1 parent 4b5382b commit b783342

3 files changed

Lines changed: 33 additions & 0 deletions

File tree

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,16 @@ Install the latest checksum-verified release on macOS or Linux:
3232
curl -fsSL https://raw.githubusercontent.com/12vault/ravel/main/install.sh | sh
3333
```
3434

35+
The installer writes to `~/.local/bin` by default. If that directory is not on `PATH`, it prints the exact command to enable it. Run that command before using `ravel`, then add it to your shell profile so future terminals can find the binary.
36+
3537
On Windows PowerShell:
3638

3739
```powershell
3840
irm https://raw.githubusercontent.com/12vault/ravel/main/install.ps1 | iex
3941
```
4042

43+
PowerShell prints the equivalent `PATH` command when `~/.local/bin` is not already available.
44+
4145
Release archives also contain a portable `ravel` binary that can run in place without installation. To build from source, install Go 1.26.5 or newer and clone the repository:
4246

4347
```sh
@@ -46,6 +50,12 @@ cd ravel
4650
go install ./cmd/ravel
4751
```
4852

53+
`go install` writes to `GOBIN`, or to `$(go env GOPATH)/bin` when `GOBIN` is unset. Make sure that directory is on `PATH`. To install the project-local Codex skill straight from this checkout without installing a global binary, run:
54+
55+
```sh
56+
go run ./cmd/ravel install --project --platform codex
57+
```
58+
4959
Register the bundled skill with your AI coding assistant:
5060

5161
```sh

install.ps1

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,13 @@ try {
2121
New-Item -ItemType Directory -Force -Path $installDir | Out-Null
2222
Copy-Item (Join-Path $tmp "ravel.exe") (Join-Path $installDir "ravel.exe") -Force
2323
Write-Output "Installed ravel to $installDir\ravel.exe"
24+
$pathEntries = $env:Path -split [IO.Path]::PathSeparator
25+
if ($pathEntries -notcontains $installDir) {
26+
Write-Warning "$installDir is not on PATH."
27+
Write-Output "Run this now:"
28+
Write-Output (' $env:Path = "{0};$env:Path"' -f $installDir)
29+
Write-Output 'Then add the same line to your PowerShell profile and open a new terminal.'
30+
}
2431
} finally {
2532
Remove-Item $tmp -Recurse -Force -ErrorAction SilentlyContinue
2633
}

install.sh

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,19 @@ tar -xzf "$tmp/$asset" -C "$tmp" ravel
3232
mkdir -p "$install_dir"
3333
install -m 0755 "$tmp/ravel" "$install_dir/ravel"
3434
echo "Installed ravel to $install_dir/ravel"
35+
36+
case ":${PATH:-}:" in
37+
*":$install_dir:"*) ;;
38+
*)
39+
echo ""
40+
echo "ravel: $install_dir is not on PATH." >&2
41+
echo "Run this now:" >&2
42+
printf ' export PATH="%s:$PATH"\n' "$install_dir" >&2
43+
case "${SHELL:-}" in
44+
*/zsh) profile="$HOME/.zshrc" ;;
45+
*/bash) profile="$HOME/.bashrc" ;;
46+
*) profile="your shell profile" ;;
47+
esac
48+
echo "Then add the same line to $profile and open a new terminal." >&2
49+
;;
50+
esac

0 commit comments

Comments
 (0)