From 0af4f51969405c012c9207332bb9fb8fdde17ddb Mon Sep 17 00:00:00 2001 From: Doug Martin Date: Wed, 22 Jul 2026 12:25:10 -0400 Subject: [PATCH 1/2] docs: add macOS and Linux install instructions to the researcher guide [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. --- docs/researcher-guide.md | 59 +++++++++++++++++++++++++++++++++++++--- 1 file changed, 55 insertions(+), 4 deletions(-) diff --git a/docs/researcher-guide.md b/docs/researcher-guide.md index 0b5e4e1..64ee840 100644 --- a/docs/researcher-guide.md +++ b/docs/researcher-guide.md @@ -28,10 +28,61 @@ whenever you want to run it yourself. ## 1. Installing the CLI -> **TBD.** Installation instructions (Homebrew formula and direct download) will -> be added here once releases are published. For now, assume you have the -> `cc-data` command available on your `PATH`. Everything below works the same way -> regardless of how the binary got installed. +`cc-data` is distributed for **macOS** and **Linux**. The macOS builds are signed +and notarized by Apple, so they install and run without security prompts. + +### macOS (recommended: Homebrew) + +``` +brew tap --trust concord-consortium/tap +brew install cc-data +``` + +- The `--trust` is required. Homebrew 6.0 and later make you trust a third-party + tap before installing from it (a supply-chain security measure). If you tapped + without it, run `brew trust concord-consortium/tap` before `brew install`. +- Homebrew installs into its own prefix and removes the download quarantine, so + there is no Gatekeeper prompt. +- Don't have Homebrew? Install it first from [brew.sh](https://brew.sh). + +**Without Homebrew:** download the macOS archive for your chip from the +[Releases page](https://github.com/concord-consortium/cc-data-cli/releases) +(`darwin_arm64` for Apple Silicon, `darwin_amd64` for Intel), unpack it, and move +`cc-data` onto your `PATH`. The binary is notarized, so on first run macOS does a +quick online check with Apple and then lets it run. + +### Linux (x86-64) + +With Homebrew on Linux: + +``` +brew tap --trust concord-consortium/tap +brew install cc-data +``` + +Or download directly (replace `X.Y.Z` with the latest version from the +[Releases page](https://github.com/concord-consortium/cc-data-cli/releases)): + +``` +curl -fsSL -o cc-data.tar.gz \ + https://github.com/concord-consortium/cc-data-cli/releases/download/vX.Y.Z/cc-data_X.Y.Z_linux_amd64.tar.gz +tar xzf cc-data.tar.gz +sudo mv cc-data /usr/local/bin/ +``` + +Only x86-64 (amd64) Linux has a prebuilt binary; on ARM Linux, build from source. + +### Build from source (any platform) + +``` +git clone https://github.com/concord-consortium/cc-data-cli.git +cd cc-data-cli +go build -o cc-data . +``` + +Requires Go 1.25 or newer and a C compiler (Xcode Command Line Tools on macOS, +`gcc`/`clang` on Linux), because the embedded DuckDB database is a cgo dependency. +A source build reports its version as `dev`, which is expected. --- From 368919770e98a51ba4d78adf6b7d22fde973ab20 Mon Sep 17 00:00:00 2001 From: Doug Martin Date: Wed, 22 Jul 2026 12:29:24 -0400 Subject: [PATCH 2/2] docs: clarify prebuilt-vs-source scope and use full asset names [REPORT-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__darwin_.tar.gz) so they're findable on the Releases page. --- docs/researcher-guide.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/researcher-guide.md b/docs/researcher-guide.md index 64ee840..202107d 100644 --- a/docs/researcher-guide.md +++ b/docs/researcher-guide.md @@ -28,8 +28,9 @@ whenever you want to run it yourself. ## 1. Installing the CLI -`cc-data` is distributed for **macOS** and **Linux**. The macOS builds are signed -and notarized by Apple, so they install and run without security prompts. +`cc-data` ships **prebuilt binaries for macOS and Linux** (on any other platform, +including Windows, you can build from source, see below). The macOS builds are +signed and notarized by Apple, so they install and run without security prompts. ### macOS (recommended: Homebrew) @@ -46,10 +47,11 @@ brew install cc-data - Don't have Homebrew? Install it first from [brew.sh](https://brew.sh). **Without Homebrew:** download the macOS archive for your chip from the -[Releases page](https://github.com/concord-consortium/cc-data-cli/releases) -(`darwin_arm64` for Apple Silicon, `darwin_amd64` for Intel), unpack it, and move -`cc-data` onto your `PATH`. The binary is notarized, so on first run macOS does a -quick online check with Apple and then lets it run. +[Releases page](https://github.com/concord-consortium/cc-data-cli/releases), +`cc-data__darwin_arm64.tar.gz` for Apple Silicon or +`cc-data__darwin_amd64.tar.gz` for Intel, unpack it, and move `cc-data` +onto your `PATH`. The binary is notarized, so on first run macOS does a quick +online check with Apple and then lets it run. ### Linux (x86-64)