Skip to content

agentknock pairing start

agentknock pairing start exchanges pairing information with your phone, saves a pending pairing, and displays its verification code. The pairing becomes usable after you accept it on the phone and run pairing finish.

Terminal window
agentknock pairing start PAIRING_ADDRESS

PAIRING_ADDRESS is required. Use the address displayed on your phone. It consists of lowercase ASCII letters, with single hyphens between words. A single word is also valid. The command uses the address exactly as supplied; it doesn’t change the case or remove spaces.

For example:

Terminal window
agentknock pairing start calm-river-lantern

Replace calm-river-lantern with your address. See Pair a client for the phone procedure and how to check the verification code.

The client must have no pending or active pairing. An existing pairing causes an error and is left unchanged. Check with pairing status; use pairing abort to discard a pending attempt or pairing remove to remove an active pairing.

Agentknock contacts the phone through the relay. It sends encrypted information identifying this client: platform, processor architecture, software versions, and, when available, hostname and OS version. On Linux it also includes the machine ID when available.

When the exchange completes, the command prints a 12-digit verification code in three groups of four digits to standard output and exits. It doesn’t wait for you to accept the pairing. The local pairing remains pending, so commands that use or manage secrets are unavailable until the pairing is active.

While waiting, the command reports progress and elapsed time to standard error every 30 seconds. See connection retries for shared waiting behavior.

Interrupting the command, for example with Ctrl+C, cancels the exchange and attempts to discard any pending state created for that attempt. If an error leaves a pending pairing behind, use pairing abort before starting again.

After the command has displayed the code, cancel the pairing with pairing abort. Reject the attempt on the phone too, if it appears there. Aborting locally doesn’t notify the phone.