Skip to main content
Run handshake help to show the installed command list.

​
Command summary

​
handshake setup

Runs guided setup. The command can:
  • Create the database.
  • Detect and register agents.
  • Install hooks, plugins, and managed skills.
  • Configure the optional background writer.
  • Install and start the login service.
  • Select another loopback port when the configured port is unavailable.
The first completed guided setup can send an anonymous install event. See Privacy.

​
handshake init

Runs the non-interactive setup path:
This command creates the database and installs agent integrations. It does not run the background-writer questionnaire.

​
handshake serve

Starts the daemon in the current terminal:
The default address is localhost:8765. Set HANDSHAKE_ADDR to select another loopback port.

​
handshake browse

Opens the terminal interface:
Aliases are b, -b, --b, and ui.

​
handshake list

On an interactive terminal, this command opens the terminal interface:
When output is piped, each line contains the session ID, title, and source agent. Handshake imports applicable Codex sessions before it writes the list.

​
handshake pull

Imports sessions from native agent storage:
Valid agent values are claude-code, codex, opencode, and hermes. The result reports scanned, new, updated, unchanged, and failed counts.

​
handshake handoff

Prints a session restore packet and handoff brief:
The argument can be an exact session ID or an unambiguous title.

​
handshake knowledge author

Configures the optional background writer. Valid writer values are claude, codex, opencode, and hermes.

​
handshake timeline

Prints prompts, agent responses, tool activity, and related commits:

​
Service commands

Install the login service:
Remove the login service:

​
handshake uninstall

Removes managed agent integrations and the login service. The command asks before it deletes session data or the binary.

​
Version and help

Version aliases are --version and -v. Help aliases are --help and -h.