Getting Started

Installation

Install the Handoff CLI and sign in in under a minute.

Install the CLI

npm  i -g handoff-env          # or: bun add -g handoff-env / pnpm add -g handoff-env
handoff login

The binary on $PATH is called handoff (not handoff-env).

Run on demand, no global install

npx handoff-env login          # or: bunx handoff-env login
npx handoff-env run -- npm start

npx/bunx fetches the package on demand.

Standalone binary, no Node/Bun required

curl -fsSL https://raw.githubusercontent.com/jtljrdn/handoff-env/main/install.sh | sh

The installer drops a compiled binary into ~/.local/bin (override with HANDOFF_INSTALL_DIR). Add that directory to your PATH if it isn't already.

Detects your OS/arch, downloads the matching binary from the latest GitHub Release, and drops it at $HOME/.local/bin/handoff. Override with HANDOFF_INSTALL_DIR=/usr/local/bin or pin a version with HANDOFF_VERSION=v0.1.0.

If you'd rather grab the binary manually, pick one from the Releases page:

  • handoff-darwin-arm64 (Apple Silicon macOS)
  • handoff-darwin-x64 (Intel macOS)
  • handoff-linux-x64
  • handoff-linux-arm64
  • handoff-win-x64.exe

chmod +x handoff-* and move it onto your PATH.

Updating

Handoff automatically checks for updates and prompts you to install them. You can also manually update:

handoff update

Downloads the latest binary from the GitHub Release and replaces the existing one.

Sign in

handoff login

This opens your browser, authenticates you against your Handoff account, and stores a token at ~/.config/handoff/auth.json. To skip the browser (handy on a headless box), pass a token directly:

handoff login --token hnd_xxxxxxxx

Next up

With the CLI installed and authenticated, you're ready to push your first project.

PreviousIntroductionNextYour first project