Skip to content

quickstart

Install the CLI from Source

Build the terminal tool using the existing DevTools and Go SDK source-workspace workflow.

Install the CLI from Source

Prerequisites

Use macOS or Linux, Go 1.25.1+, and source checkouts of devtools and teammately-go. The source build uses the Go SDK module for transport and resources. Browser login additionally needs macOS Keychain or an unlocked Linux Secret Service with secret-tool.

Build with the SDK checkout

From the devtools checkout, create a local Go workspace if it has none:

Shell
go work init . /path/to/teammately-go
make build
./bin/teammately --version
./bin/teammately --help

If a workspace already exists, use go work use /path/to/teammately-go instead of init. Keep this local workspace separate from published module dependencies. make build writes bin/teammately; a source build reports dev unless build metadata is supplied.

Put that binary on your terminal's PATH using your team's normal tool installation method. These guides use teammately to refer to the selected binary. Use ./bin/teammately directly when working from the checkout.

Verify and maintain

Run teammately --version and teammately --help to confirm the selected binary. Follow Authentication for organization access; local help does not establish API access.

Update a source installation from the same source/build workflow. teammately update is for installer-managed releases and does not update source builds. Restart coding-agent hosts after replacing the binary so their MCP processes use the intended copy.

Common failures

  • Missing SDK module: check that the Go workspace contains the application and SDK checkouts.
  • Wrong command version: inspect the binary selected by PATH.
  • Linux login cannot store credentials: unlock/configure Secret Service; there is no plaintext-token fallback.
  • A Windows environment: this CLI's receipt-locking and credential paths target macOS/Linux.

Found something unclear?

Report outdated, unsupported, or confusing docs so we can fix the source page.

Report a docs issue

Continue learning

Related docs