CLI commands
Install, inspect, pair, update, disable, remove, or restore Agent Approve.
Run npx agentapprove help to confirm the commands supported by the version installed on your computer. Running npx agentapprove with no command opens the installation wizard.
| Command | Purpose |
|---|---|
npx agentapprove install | Install or update integrations and settings. |
npx agentapprove pair | Link a new iOS device or repair end-to-end encryption pairing. |
npx agentapprove refresh | Create a new token while reusing the current pairing context. |
npx agentapprove status | Show the current configuration. |
npx agentapprove profiles | Manage Agent Approve across Hermes profiles. |
npx agentapprove init-repo | Add the GitHub Copilot CLI hook file to the current repository. |
npx agentapprove disable | Temporarily disable installed hooks. |
npx agentapprove enable | Re-enable disabled hooks. |
npx agentapprove uninstall | Remove hooks and plugins but keep local Agent Approve state. |
npx agentapprove purge | Remove hooks and plugins and delete local Agent Approve state. |
npx agentapprove restore | Restore the original integration configuration from backup. |
purge removes more than uninstall and asks for confirmation. Read each prompt before continuing, especially when end-to-end encryption keys are present.
Install or change settings
Run npx agentapprove install when you want to add an integration, update installed hooks or plugins, or change the computer's security mode, offline fallback, privacy level, encryption choice, retention, or debug logging.
The installer shows the current configuration before replacing it. Keep the current pairing when you only want to update hooks.
Pair compared with refresh
pairlinks another iOS device or repairs encryption pairing. It lets you choose a current key, a backup key, or a new key.refreshcreates a new access token while reusing the current encryption pairing.
Use refresh for an expired token. Use pair when the device or encryption key also needs attention.
Most security and privacy choices are interactive so the installer can explain their consequences before changing the installation.
For a request that does not reach your phone, start with Trace a request with the hook debug log.