Start

Installation

Install, verify, upgrade and remove the ClockingCloud CLI, and where it keeps its files.

Requirements

Platform	Architectures	Notes
macOS 13 or later	Apple silicon (arm64), Intel (x86_64)	Binaries are code-signed and notarized.
Linux	x86_64, arm64	Statically linked. No system libraries required beyond a kernel with TLS support.
Windows	Through WSL 2	Install inside your Linux distribution. A native Windows build is not available yet.

The CLI needs outbound HTTPS (port 443) to www.clockingcloud.com. Behind a proxy, set HTTPS_PROXY.

Install with Homebrew

Terminal

brew install clockingcloud/tap/clockingcloud

This taps clockingcloud/tap (the repository github.com/clockingcloud/homebrew-tap) and installs the clockingcloud formula in one step. The formula installs the executable, shell completions for bash, zsh and fish, and a man page.

Homebrew only resolves the short name brew install clockingcloud after the tap is added and the formula is trusted. The fully qualified form above always works.

Verify the installation

Terminal

clockingcloud version
clockingcloud doctor

clockingcloud doctor checks the CLI version, the permissions on the configuration directory, your login, and reachability of the API.

Shell completions and man page

Homebrew installs completions automatically. Follow Homebrew shell completion once so your shell loads them. To install by hand:

zsh

clockingcloud completion zsh > "${fpath[1]}/_clockingcloud"

bash

clockingcloud completion bash > /usr/local/etc/bash_completion.d/clockingcloud

fish

clockingcloud completion fish > ~/.config/fish/completions/clockingcloud.fish

Man page

man clockingcloud

Install without Homebrew

Download the archive for your platform from the release host, verify its checksum, and put the binary on your PATH.

Linux x86_64 example

VERSION=0.1.0
BASE=https://releases.clockingcloud.com/cli/v$VERSION
curl -fsSLO $BASE/clockingcloud_${VERSION}_linux_amd64.tar.gz
curl -fsSLO $BASE/SHA256SUMS
grep linux_amd64 SHA256SUMS | sha256sum -c -
tar -xzf clockingcloud_${VERSION}_linux_amd64.tar.gz
sudo install -m 0755 clockingcloud /usr/local/bin/clockingcloud

Archive	Platform
clockingcloud_<version>_darwin_arm64.tar.gz	macOS, Apple silicon
clockingcloud_<version>_darwin_amd64.tar.gz	macOS, Intel
clockingcloud_<version>_linux_arm64.tar.gz	Linux, arm64
clockingcloud_<version>_linux_amd64.tar.gz	Linux, x86_64

On macOS use shasum -a 256 -c instead of sha256sum -c.

Upgrade

Terminal

brew update
brew upgrade clockingcloud

The CLI checks for a newer version at most once a day and prints a one-line notice. It never replaces itself. Disable the check with CLOCKINGCLOUD_NO_UPDATE_CHECK=1 or clockingcloud config set update_check false.

Uninstall

Terminal

brew uninstall clockingcloud
brew untap clockingcloud/tap

Uninstalling does not touch your cloud resources or local files. To remove local state as well, delete the configuration and cache directories below. Running instances keep running and billing until you stop them with clockingcloud stop or the console.

Files and directories

Path	Purpose
~/.config/clockingcloud/config.toml	CLI settings (output format, API URL, update check).
~/.config/clockingcloud/credentials.json	Login credential. Created with mode 0600. Do not commit or share it.
~/.cache/clockingcloud/	Update-check timestamp and completion caches. Safe to delete.
./clockingcloud.yaml	Per-project instance definition.

CLOCKINGCLOUD_CONFIG_DIR overrides the configuration directory. $XDG_CONFIG_HOME and $XDG_CACHE_HOME are honored.

Something unclear or missing? Email hello@clockingcloud.com.