Skip to content

docs: add macOS and Linux install instructions to the researcher guide#5

Merged
dougmartin merged 2 commits into
mainfrom
REPORT-77-researcher-guide-install
Jul 22, 2026
Merged

docs: add macOS and Linux install instructions to the researcher guide#5
dougmartin merged 2 commits into
mainfrom
REPORT-77-researcher-guide-install

Conversation

@dougmartin

Copy link
Copy Markdown
Member

Summary

Replaces the "TBD" placeholder in the researcher guide's "Installing the CLI" section with real instructions, now that the signed + notarized release and the concord-consortium/homebrew-tap are working end to end.

Covers

  • macOS (recommended: Homebrew) with the brew tap --trust step that Homebrew 6.0+ requires for third-party taps, plus a "without Homebrew" direct-download path noting the notarized binary's first-run online check.
  • Linux (x86-64) via Homebrew-on-Linux or a direct curl + extract + install, with a note that ARM Linux needs a source build.
  • Build from source (any platform) via go build, noting Go 1.25+ and the C compiler needed for the DuckDB cgo dependency, and that a source build reports its version as dev.

Windows is intentionally omitted (no Windows binary is built or published).

Notes

  • The direct Linux download uses a vX.Y.Z placeholder pointing at the Releases page rather than a hardcoded version, since only pre-release test tags exist so far. Worth revisiting once a real version is cut.

…e [REPORT-77]

Replace the TBD placeholder in the researcher guide with real install steps now
that the signed/notarized release and Homebrew tap are live: macOS via Homebrew
(including the Homebrew 6.0 'brew tap --trust' requirement) or direct download,
Linux via Homebrew-on-Linux or a direct tarball, plus a build-from-source path.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the researcher guide to replace the “TBD” install placeholder with concrete installation paths now that signed/notarized releases and a Homebrew tap are available.

Changes:

  • Adds macOS install instructions (Homebrew + direct download) with notes about Gatekeeper/notarization behavior.
  • Adds Linux (x86-64) install instructions (Homebrew-on-Linux + direct download) and ARM guidance.
  • Adds “build from source” instructions including Go/C toolchain requirements.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/researcher-guide.md Outdated
Comment thread docs/researcher-guide.md Outdated
…RT-77]

Address the Copilot review on the install section: say cc-data ships prebuilt
binaries for macOS and Linux (source builds work anywhere, including Windows) to
avoid implying no Windows support, and reference the full release asset filenames
(cc-data_<version>_darwin_<arch>.tar.gz) so they're findable on the Releases page.
@dougmartin
dougmartin requested a review from emcelroy July 22, 2026 16:40

@emcelroy emcelroy left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good 👍

@dougmartin
dougmartin merged commit 8424bc2 into main Jul 22, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants