Install the agent skill
The Agentknock skill gives any LLM instructions for installing and pairing Agentknock, running commands with secrets, and migrating existing credentials to your phone.
The plugin packages the same skill with OpenAI and Anthropic plugin metadata and marketplaces. You can use the skill directly or install it through a compatible plugin system.
The Agentknock CLI is installed separately in the environment where your agent runs commands, either by you or with your agent’s help. You also need the mobile app to pair a client and use secrets.
Install the skill directly
Section titled “Install the skill directly”Copy the agentknock skill directory into your agent environment’s skill location. Keep SKILL.md and its references/ directory together; the agent reads installation, pairing, and migration guidance from those files.
For an environment without a skill loader, provide SKILL.md and the referenced files as instructions or context. The agent needs access to a command execution environment to use the CLI.
Install through a plugin
Section titled “Install through a plugin”The following examples use the supplied OpenAI and Anthropic integrations.
Codex CLI
Section titled “Codex CLI”Run these commands in your terminal:
codex plugin marketplace add agentknock/agentknock-plugin --ref mastercodex plugin add agentknock@agentknockStart a new Codex session. Use $agentknock to select the skill explicitly, or mention Agentknock in your request.
Claude Code
Section titled “Claude Code”Run these commands in your terminal:
claude plugin marketplace add https://github.com/agentknock/agentknock-plugin.git#masterclaude plugin install agentknock@agentknockStart a new Claude Code session. Use /agentknock:agentknock to select the skill explicitly, or mention Agentknock in your request.
ChatGPT Work
Section titled “ChatGPT Work”For a workspace-managed installation, a workspace admin imports the GitHub marketplace through Admin → Plugins → Add → Import marketplace with these settings:
| Field | Value |
|---|---|
| Source | https://github.com/agentknock/agentknock-plugin |
| Path | Leave empty |
| Branch, tag, or commit | master |
The admin then makes Agentknock available to the appropriate workspace roles. Install it from the workspace’s Plugins tab and start a new Work conversation. See OpenAI’s workspace plugin instructions for availability and access requirements.
Use the skill
Section titled “Use the skill”Once the skill is available to your agent, ask:
Set up Agentknock on this machine.
The agent can reuse an existing CLI installation or help install one. In a hosted environment, it checks how the installation and pairing can persist across sessions and explains any limitations.
If the client is not paired, ask:
Pair Agentknock with my phone.
Compare the complete verification code shown by the agent with the code on your phone. Approve only if they match, then reply to the agent so it can finish pairing.
Once paired, ask for the operation you want, for example:
Use Agentknock to list the issues in my GitHub repository.
Sign this Git commit using my SSH key in Agentknock.
Help me migrate my local SSH key to Agentknock.
The agent can discover available secret names and wrap the command with Agentknock. Approval may be automatic; your phone notifies you when action is needed, and the command waits while approval is pending.
You can also use Agentknock directly from a terminal. The CLI reference documents the commands and options.
Update the skill
Section titled “Update the skill”Skill and plugin updates follow the repository’s master branch. There are no numbered releases or release downloads.
For a direct installation, replace the skill directory, including references/, with the current copy from the repository. For plugin installations, use your environment’s marketplace update mechanism. Examples:
For Codex CLI, refresh the marketplace and the installed plugin:
codex plugin marketplace upgrade agentknockcodex plugin add agentknock@agentknockFor Claude Code, refresh the marketplace and update the plugin:
claude plugin marketplace update agentknockclaude plugin update agentknock@agentknockStart a new session after updating. Claude Code also offers automatic updates under /plugin → Marketplaces → agentknock; see its update instructions.
Workspace-managed ChatGPT installations follow the workspace’s marketplace sync settings. Skill and plugin updates change the instructions; update the CLI separately through the method used to install it.
For skill or plugin problems or suggestions, open an issue in the repository. See Report a bug or contribute for what to include.