CLI guide
GitHub

Install

Homebrew (macOS / Linux)

brew install source-cooperative/tap/source-coop

macOS / Linux:

curl --proto '=https' --tlsv1.2 -LsSf \
  https://github.com/source-cooperative/source-coop-cli/releases/latest/download/source-coop-cli-installer.sh | sh

Windows PowerShell:

powershell -ExecutionPolicy ByPass -c "irm https://github.com/source-cooperative/source-coop-cli/releases/latest/download/source-coop-cli-installer.ps1 | iex"

From source

cargo install --git https://github.com/source-cooperative/source-coop-cli

To see the installed version:

source-coop --version

Upgrade

Upgrade the way you installed:

# Homebrew
brew upgrade source-coop

# from source
cargo install --force --git https://github.com/source-cooperative/source-coop-cli

With the installer script, run it again. It replaces the installed version with the latest release.

The changelog lists what each release changes. On macOS, the first command after an upgrade that reads your session can ask for your keychain password (see Troubleshooting).

Uninstall

  1. Sign out, to remove the session and cached credentials from the OS keyring:

    source-coop auth logout

    This removes one environment and one role. Run it again with --role-arn or --proxy-url for each other one that you used.

  2. Remove the CLI:

    # Homebrew
brew uninstall source-coop

# installer script or from source
rm ~/.cargo/bin/source-coop

    On Windows, delete source-coop.exe from %USERPROFILE%\.cargo\bin.

  3. Remove the files it kept: the source-coop folders in the file fallback and drafts locations, if they exist.