Skip to content

docs: fix binary install location documentation #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
beonde merged 1 commit into from
May 2, 2026
Merged

docs: fix binary install location documentation #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,11 @@ The Node.js wrapper includes specific commands to manage the binary:
## How It Works

1. **Detection**: When you run `capiscio`, the script detects your OS (Linux, macOS, Windows) and Architecture (AMD64, ARM64).
2. **Provisioning**: It checks if the correct `capiscio-core` binary is present in the cache.
- *Linux/macOS*: `~/.capiscio/bin`
- *Windows*: `%USERPROFILE%\.capiscio\bin`
3. **Download**: If missing, it securely downloads the release from GitHub.
2. **Provisioning**: It checks if the correct `capiscio-core` binary is present:
- **Primary**: `<package>/bin/capiscio` (alongside node_modules)
- **Fallback**: `~/.capiscio/bin/capiscio` (if package dir is read-only)
- *Windows fallback*: `%USERPROFILE%\.capiscio\bin`
Comment on lines +59 to +61
3. **Download**: If missing, it downloads the release from GitHub on first run (no postinstall script).
4. **Execution**: It seamlessly delegates to the Go binary, passing all arguments through.

## Supported Platforms
Expand Down
7 changes: 4 additions & 3 deletions docs/getting-started/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,11 @@ $ capiscio --version
capiscio version 1.0.2
```

The binary is cached in:
The binary is stored in:

- **macOS/Linux**: `~/.capiscio/bin/`
- **Windows**: `%USERPROFILE%\.capiscio\bin\`
- **Primary**: `<package>/bin/capiscio` (alongside node_modules)
- **Fallback**: `~/.capiscio/bin/capiscio` (if package dir is read-only)
- **Windows fallback**: `%USERPROFILE%\.capiscio\bin\`
Comment on lines +47 to +49

## Environment Variables

Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,10 +89,10 @@ capiscio --version
## What This Package Does

1. **Downloads** the correct `capiscio-core` binary for your platform (macOS/Linux/Windows, AMD64/ARM64)
2. **Caches** the binary in `~/.capiscio/bin` (or `%USERPROFILE%\.capiscio\bin` on Windows)
2. **Caches** the binary in `<package>/bin/` (primary) or `~/.capiscio/bin` (fallback if package dir is read-only)
3. **Executes** the binary with your arguments via `execa` with inherited stdio

All validation logic lives in `capiscio-core`. This wrapper just makes it easy to install via npm.
All validation logic lives in `capiscio-core`. This wrapper just makes it easy to install via npm. No postinstall script runs — download happens lazily on first command.

## Wrapper-Specific Commands

Expand Down
Loading