Skip to content

docs(install): warn about multiple distribution channels (#314) #320

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
ajianaz merged 1 commit into from
Jun 17, 2026
Merged

docs(install): warn about multiple distribution channels (#314) #320

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
7 changes: 7 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- `install.sh` now runs `xattr -dr` for both attributes on the installed binary on macOS (best-effort, non-fatal).
- Added a prominent `<details>` block in the README install section explaining the symptom, the manual `xattr` workaround for users who download the binary directly, and the `cargo` / Homebrew alternatives.

### Changed — Docs

- **Install section now warns about multiple distribution channels (#314)**
- Recommends a single install method per platform and lists the supported channels (installer script, `cargo`, pre-built binaries).
- Adds a `which -a cora && cora --version` check snippet and guidance for removing stale copies when more than one `cora` is on `PATH` (e.g. `~/.local/bin` vs `~/.cargo/bin` vs npm global).
- Cross-links the original issue for background.

## [0.6.0] - 2026-06-14

### Added — Code Intelligence
Expand Down
26 changes: 22 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,17 +36,35 @@

### Install

Pick **one** install method — mixing channels can leave stale binaries on your `PATH`.

| Method | When to use |
|---|---|
| **`curl … install.sh`** (recommended) | Quick standalone install; fetches the latest GitHub release binary |
| **`cargo install --git …`** | You already have a Rust toolchain; builds from source |
| **Pre-built binaries** | Manual download from [Releases](https://github.com/codecoradev/cora-cli/releases) |

```bash
# Cora only (standalone)
# Recommended: Cora only (standalone)
curl -fsSL https://raw.githubusercontent.com/codecoradev/cora-cli/main/install.sh | sh

# Or install both Cora + Uteke (code review with memory)
curl -fsSL https://raw.githubusercontent.com/codecoradev/cora-cli/main/install-bundle.sh | sh

# Or build from source with cargo
cargo install --git https://github.com/codecoradev/cora-cli
```

> Pin a version: `CORA_VERSION=v0.6.0 curl -fsSL ... | sh`

**Verify which `cora` you're running** — `which -a cora` will reveal stale copies from other channels:

```bash
which -a cora # list every `cora` on your PATH (one entry = healthy)
cora --version # should match the latest release
```

> Pin a version: `CORA_VERSION=v0.6.0 curl -fsSL ... | sh`
> Or: `cargo install --git https://github.com/codecoradev/cora-cli`
> Pre-built binaries: [GitHub Releases](https://github.com/codecoradev/cora-cli/releases)
If `which -a cora` shows more than one path (e.g. `~/.local/bin/cora` and `~/.cargo/bin/cora`), remove the one you don't want or reorder your `PATH`. See [Issue #314](https://github.com/codecoradev/cora-cli/issues/314) for background.

<details>
<summary><b>macOS note — binary killed on launch (<code>Killed: 9</code>)?</b></summary>
Expand Down
Loading