GreatPingCLI commands
Every greatping command at a glance.
Every command has --help. Results go to standard output, messages and progress to standard error. greatping ask waits for your reply and prints it in the terminal. Color follows NO_COLOR, FORCE_COLOR and --no-color.
Pairing
| Command | Does |
|---|---|
greatping login [--name NAME] | Pair this computer with the app (QR code or typed code). |
greatping status [--json] | Pairing, devices, pause and agents. |
greatping logout | Unpair this computer. Integrations stay installed. |
Agents
| Command | Does |
|---|---|
greatping setup [claude|codex|opencode|pi|cursor] | Choose agents, alerts, tools and the skill. |
greatping setup AGENT --remove | Remove an agent's integration, keep the pairing. |
greatping doctor [--fix] [--verbose] | Check pairing, hooks and tools, and repair them. |
greatping hooks [install|uninstall|status] [AGENT] | Manage only the hooks. |
greatping mcp | Run the MCP tools over stdio. |
Alerts
| Command | Does |
|---|---|
greatping notify MESSAGE [--title T] | Send a message. |
greatping ask QUESTION [--choices A,B] [--allow-text] [--timeout 5m] | Ask and print the answer. |
greatping run [--on-fail] [--title T] -- COMMAND | Alert when a command ends. |
greatping test | Test notification to every device, with Apple's or Google's answer. |
greatping pause 2h / greatping resume | Silence this computer on every device. |
greatping project … | Project labels. |
Maintenance
| Command | Does |
|---|---|
greatping update --check | Check for a new version and show how to update this installation. |
greatping uninstall [--dry-run] | Remove integrations, the pairing and local data, then the package. |
GREATPING_DISABLE=1 silences hooks for one shell or session. --no-update-check or NO_UPDATE_NOTIFIER=1 turns off update notices.
Exit codes
| Code | Meaning |
|---|---|
0 | Success |
1 | Error, including "not paired" for status |
2 | A question or pairing code ended without an answer |
3 | An answer arrived that could not be verified |
130, 143 | Interrupted |
Where it keeps data
The pairing credential and keys are in ~/.config/greatping/config.json on macOS and Linux, and in %APPDATA%\greatping\config.json on Windows, readable only by you.