setup
Set up and verify AgentGuards in Codex. Use when the user asks to configure AgentGuards, set their API key, or check that the guardrails are wired up correctly.
- License 许可
- Apache-2.0
- 最近更新
- 2026-11-14
- Stars
- ★ 1.6k
- Forks
- 491
01 前言 Front Matter
- name
- setup
- description
- Set up and verify AgentGuards in Codex. Use when the user asks to configure AgentGuards, set their API key, or check that the guardrails are wired up correctly.
03 SKILL.md 正文
AgentGuards setup
Guide the user through finishing AgentGuards setup after installing the plugin. The plugin already bundles the enforcing hooks — the only thing the user must supply is their API key.
Steps
-
Check for the API key. The hooks use the first of: the
AGENTGUARDS_API_KEYenvironment variable,~/.codex/agentguards_token, then~/.agentguards/credentials.json. If none holds a key starting withag_, the easiest fix is the AgentGuards CLI:agentguards loginsigns in through the browser and saves the key where the hooks read it (install the CLI from https://agentguards.co if it isn't there). Otherwise, tell the user to:-
Get a key from the dashboard at https://agentguards.co/dashboard/keys
-
Export it so the hooks can read it. For the current shell and future sessions, add to their shell profile (
~/.bashrc,~/.zshrc, etc.):export AGENTGUARDS_API_KEY=ag_your_token_here -
Restart Codex (or start a new session) so the hooks pick up the key.
-
-
Confirm the URL (optional). AgentGuards defaults to
https://prod.agentguards.co. Only setAGENTGUARDS_URLif the user runs a self-hosted instance. -
Fail-open vs fail-closed. The hooks fail closed by default — if the AgentGuards service is unreachable, actions are blocked. A user who prefers availability over strict enforcement can set
AGENTGUARDS_FAIL_OPEN=true. Mention this only if they ask or report unexpected blocks. -
Verify. Run the checks in the
statusskill yourself: they prove the key is accepted (HTTP 200), not just present. If it fails, the most common cause isAGENTGUARDS_API_KEYnot being exported in the environment Codex was launched from. -
Summarize what is now active: prompt screening, shell-command authorization (with Codex's approval prompt for anything borderline), scanning of content fetched by shell commands, and security scanning of
apply_patchedits.
04 同仓库更多 Skills
worktable-review-with-annotations
Create, inspect, reply to, update, or resolve situated Worktable annotations. Use when feedback belongs to a Doc section, block, text range, or HTML Doc, or when the user asks to address existing review feedback and coordinate a requested artifact edit.
worktable-find-and-synthesize-context
Find, assess, and synthesize context from Worktable Docs and Records. Use when the user asks what a workspace contains, wants workspace-backed research, needs current facts reconciled across artifacts, or requests a cited synthesis without changing workspace state.
worktable-create-or-update-docs
Create, edit, rename, or maintain narrative Worktable Docs. Use for plans, decisions, briefs, notes, research syntheses, and other durable prose when the user requests a new artifact or a safe update to an existing one.
worktable-create-or-manage-records
Organize repeated structured information as durable Worktable Records. Use for research datasets, inventories, directories, pipelines, trackers, and other collections whose items need identity, fields, filtering, links, validation, or individual updates.
worktable-create-or-manage-interactive-html
Create or improve durable visual and interactive artifacts in Worktable. Use for dashboards, trackers, calculators, mini apps, slide presentations, and other requests that benefit from a polished HTML Doc.
worktable-collaborate-threads
Read, answer, and hand off messages through durable Worktable threads with users or other authenticated participants. Use when the user asks to check addressed messages, reply to a participant, continue a thread, request another agent's help, wait briefly for a response, or watch for comments and messages sent to the agent.