Getting started

Try a complete request with a made-up token. You do not need a database, a cloud account, or an existing credential. The test command prints the value so you can see it arrive.

Install and pair

1. Install the mobile app and complete its initial setup.
2. Install the CLI on the computer where you will run commands.
3. Follow Pair a computer to connect them. That guide walks through the verification code and the final confirmation on your computer.

Keep the phone and computer online. Once the pairing is complete, the computer appears under Clients on your phone and can request secrets.

Create a test secret

On the phone, open Secrets and choose New secret. Keep Environment variables as the type, and enter example as the secret’s name.

Add one variable:

Field	Value
Name	EXAMPLE_TOKEN
Value	hello-agentknock
Sensitive	On

Leave Sensitive enabled even though this is a test value: it makes delivery follow the secret’s approval settings. Choose Create secret. The new secret starts in Ask mode, so its first request will need your decision.

Request it from the computer

Run:

agentknock -s example --reason "Try Agentknock with a test value" \
  -- printenv EXAMPLE_TOKEN

The terminal waits. On your phone, open the incoming request from its notification or from Requests. Check that it names your computer and the example secret, and that the command is printenv EXAMPLE_TOKEN with the reason you supplied.

Choose Allow once. The CLI starts printenv, which prints:

hello-agentknock

The phone supplied the value for that command. Agentknock did not save it in your project or client configuration.

To see a denial, run the same command again and choose Deny once. The command will not run. If no request appears, check that both devices are online and use Troubleshooting.

Use your own credentials

You can now delete the example secret from its details. For a real task, import existing credentials or follow Run a command with credentials to connect to a database. If you need a private key, start with Connect over SSH or Sign commits and tags.

The rest of Features covers access settings, coding-agent workflows, credential changes, and activity review.