CLI Install

Install the nudge CLI for the simplest possible integration.

Install

Install the nudge CLI with Homebrew:

brew

brew install Dotsquare-Labs/tap/nudge

Setup

Authenticate by running nudge login. This opens your browser for phone verification:

bash

nudge login
# Opens your browser to verify your phone number

Once authenticated, you can view your current token at any time:

bash

nudge token
# Prints your current API token

Usage

Wrap any command with nudge -- to get notified when it finishes. The CLI auto-captures exit code, duration, and stdout/stderr:

bash

# Wrap a build command
nudge -- npm run build

It works with any command on any system:

bash

# Deploy script
nudge -- make deploy

# ML training
nudge -- python train.py

# With a label for easy identification
nudge -l "prod deploy" -- kubectl apply -f deploy.yaml

CLI Options

Pass these flags before the -- separator:

Flag	Type	Description
--label, -l	string	A label for the task, e.g. `"prod deploy"`. Helps you identify which job sent the nudge.
--message, -m	string	Custom message body. Overrides the default format with your own text.
--silent, -s	boolean	Suppress all CLI output. The wrapped command's output is still captured and sent.
--token, -t	string	Override the stored token for this run. Useful for CI or when sending nudges to a different account.

Zero config in CI

In CI environments, pass the token directly with nudge -t $NUDGE_TOKEN -- your-command. No login step needed.

Uninstall

Remove the CLI when you no longer need it:

brew

brew uninstall nudge

Next Steps

Previous Reference