Capture an agent session, find a failure, and start preventing it.
This quickstart gets one machine reporting sessions, runs an audit, and deploys a policy. Use the skill to set Failproof up, or follow the manual steps.Which path is yours? If your agent runs in one of the 12 supported harnesses — a coding CLI, or a gateway like Hermes or OpenClaw — follow the steps below; you need Node.js 20.9 or later. If your agent has no harness, instrument it with the Python SDK for tracing and audits, then rejoin at Run your first failure check; enforcement on that path needs a hook in your runtime.
Use the skill
Manual setup
1
Install the Failproof AI skills
npx skills add FailproofAI/skills
2
Ask your agent to set everything up
Set up Failproof AI for this project, connect this machine, install the right hooks and policies, and verify that a session arrives.
Your agent inspects the project, chooses the relevant integration, performs the setup, and verifies it. See the FailproofAI skills repository for individual skills and advanced installation options.
Install
1
Install and connect Failproof AI
npm install -g failproofaifailproofai config
That one command is the whole of setup: it installs the local daemon (root once), wires hooks into every agent CLI it finds, and connects this machine to Cloud.At Connect to cloud, setup starts logging you in to FailproofAI Cloud straight away (press Tab for the other options: paste an API key, or use open source). It opens a link in your browser (over SSH, or on a machine with no display, it prints the link so you can open it on any device). Sign up or sign in, confirm the org — or create one right there — and click Authorize. The key’s name and permissions are set for you. You do not need an account beforehand.The terminal notices on its own and shows who approved it and for which org. Confirm the agents to trace, and setup finishes. The machine’s key is created only at that point, after the daemon is installed, so a run you abandon leaves no key behind; it appears under Administration → Keys marked cli login, where you can revoke it.
No browser or terminal at hand? Use a key (CI, containers, provisioning scripts)
In the Failproof AI dashboard, go to Administration → Keys and create a key with events:add and policies:pull. If you plan to use Jev through FailproofAI Cloud, choose the machine preset, which also grants jev:evaluate. Copy the one-time secret and read it into a shell on the target machine — read -s takes it at a prompt that does not echo:
Passing the key through the environment rather than --token keeps it out of ps, where every user on the machine can read a command’s arguments. It does not keep it out of shell history — reading it with read -s is what does that. In CI, inject it as a masked secret and keep shell tracing (set -x) off, or the trace prints it. In an interactive run you can also pick Paste an API key at Connect to cloud instead.
Session transcripts are sent by default. Add --no-transcripts to report hook activity and policy decisions without transcript content.
Do not reach for failproofai config --connect <url> here. That flag enrols a machine that is already set up and returns straight after — no daemon, no hooks — so the machine would appear in Cloud while collecting and enforcing nothing.
If this machine already has agent history, preview and import the last seven days, then wait for delivery to finish. Skip this step on a new machine.
Open Sessions in Failproof AI and select an imported session.
2
Attach Failproof AI to a harness
The previous step already wired every agent CLI it detected. Re-run it for one harness explicitly when you need to, or to add a harness installed afterwards. Every one of the 12 is a valid --cli value — claude, codex, copilot, cursor, opencode, pi, hermes, openclaw, factory, devin, antigravity, goose.
failproofai policies --install --cli claude --scope user # a coding CLIfailproofai policies --install --cli hermes --scope user # a Slack/Telegram gateway
Blocking a tool call before it runs is verified on all 12. Turn-end gates are verified on 8 — see enforcement capability for the per-harness matrix.
3
Choose what to enforce
Wiring hooks enables no policy. Setup deliberately picks none — that decision is yours — so take a pack:
failproofai policies add FailproofAI/policies
The pack is fetched from its GitHub release, checksum-verified, and pinned to the exact tag it resolved. It carries 39 policies and switches on the 10 its manifest marks as safe to enable unattended. Use them to see local policy decisions and try enforcement before Failproof AI audits your sessions and writes policies for your agents.Read any pack before taking it with failproofai policies show <owner>/<repo>, and see policy packs for taking only part of one.Until this runs, the only thing enforcing is block-failproofai-commands — the always-on guard that stops an agent switching Failproof AI off. failproofai policies lists what is on.
4
Audit the behavior
Follow Run your first failure check. Use a concrete goal such as “find sessions where the agent retried a failing tool without changing its approach.”
Run failproofai config --status. A healthy setup reports the cloud connection, daemon state, and whether enforcement is paused.
Jev setup
Use Jev to score finished sessions against a question with known answers, or to review tool calls in context before they run. The Use Jev page has both setup paths.
Was this page helpful?
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"Failproof AI","description":"Trace agent behavior, find failures with audits, and prevent repeat failures with deployed policies.","colors":{"primary":"#c92251","light":"#e4587d","dark":"#e4587d"},"logo":{"light":"https://mintcdn.com/exosphere/63Tp--IVddVBndpp/logo/Failproof_AI_logo_light.png?fit=max\u0026auto=format\u0026n=63Tp--IVddVBndpp\u0026q=85\u0026s=5231ac600a18d7ad299834e4a880f6e0","dark":"https://mintcdn.com/exosphere/63Tp--IVddVBndpp/logo/Failproof_AI_logo.png?fit=max\u0026auto=format\u0026n=63Tp--IVddVBndpp\u0026q=85\u0026s=3f0e8fc7951c3550b7fdeabbca03daff","href":"https://befailproof.ai"},"favicon":"https://mintcdn.com/exosphere/63Tp--IVddVBndpp/favicon.ico?fit=max\u0026auto=format\u0026n=63Tp--IVddVBndpp\u0026q=85\u0026s=ef7e5e9c419deaf5a2298f5ef6d5929f","api":{"openapi":"reference/openapi.json","playground":{"display":"simple"},"examples":{"languages":["curl","python","javascript"]}},"navbar":{"links":[{"icon":"discord","href":"https://discord.befailproof.ai","label":""},{"icon":"reddit","href":"https://www.reddit.com/r/failproofai/","label":""},{"icon":"x-twitter","href":"https://x.com/failproofai","label":""},{"icon":"github","href":"https://github.com/FailproofAI/failproofai","label":"⭐ 1.5k"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.befailproof.ai"}},"footer":{"socials":{"github":"https://github.com/FailproofAI/failproofai","x":"https://x.com/failproofai"}},"search":{"prompt":"Search Failproof AI docs"},"seo":{"indexing":"navigable"},"icons":{"library":"lucide"},"contextual":{"options":["copy","view","assistant","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Support","icon":"mail","href":"mailto:support@befailproof.ai"}]},"languages":[{"language":"en","href":""},{"language":"zh","href":"zh"},{"language":"ja","href":"ja"},{"language":"ko","href":"ko"},{"language":"es","href":"es"},{"language":"pt-BR","href":"pt-br"},{"language":"de","href":"de"},{"language":"fr","href":"fr"},{"language":"ru","href":"ru"},{"language":"hi","href":"hi"},{"language":"tr","href":"tr"},{"language":"vi","href":"vi"},{"language":"it","href":"it"},{"language":"ar","href":"ar"},{"language":"he","href":"he"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"exosphere","hasAudioNarration":false,"actualSubdomain":"exosphere","customDomains":["docs.befailproof.ai"],"gitSource":{"type":"github","owner":"failproofai","repo":"failproofai","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6af7199f9a8829f8111dfce3","clientVersion":"0.0.4167","searchFilterCounts":[{"language":"en","tag":"Integrations and reference","count":130},{"language":"en","tag":"HTTP API","count":109},{"language":"en","tag":"Trace Agents","count":18},{"language":"en","tag":"Audits","count":18},{"language":"en","tag":"Find failures","count":17},{"language":"ar","tag":"Trace Agents","count":17},{"language":"de","tag":"Trace Agents","count":17},{"language":"es","tag":"Trace Agents","count":17},{"language":"fr","tag":"Trace Agents","count":17},{"language":"he","tag":"Trace Agents","count":17},{"language":"hi","tag":"Trace Agents","count":17},{"language":"it","tag":"Trace Agents","count":17},{"language":"ja","tag":"Trace Agents","count":17},{"language":"ko","tag":"Trace Agents","count":17},{"language":"pt-BR","tag":"Trace Agents","count":17},{"language":"ru","tag":"Trace Agents","count":17},{"language":"tr","tag":"Trace Agents","count":17},{"language":"vi","tag":"Trace Agents","count":17},{"language":"zh","tag":"Trace Agents","count":17},{"language":"en","tag":"Issues","count":15},{"language":"en","tag":"Events","count":14},{"language":"ar","tag":"Find failures","count":14},{"language":"de","tag":"Find failures","count":14},{"language":"es","tag":"Find failures","count":14},{"language":"fr","tag":"Find failures","count":14},{"language":"he","tag":"Find failures","count":14},{"language":"hi","tag":"Find failures","count":14},{"language":"it","tag":"Find failures","count":14},{"language":"ja","tag":"Find failures","count":14},{"language":"ko","tag":"Find failures","count":14},{"language":"pt-BR","tag":"Find failures","count":14},{"language":"ru","tag":"Find failures","count":14},{"language":"tr","tag":"Find failures","count":14},{"language":"vi","tag":"Find failures","count":14},{"language":"zh","tag":"Find failures","count":14},{"language":"en","tag":"Start","count":13},{"language":"en","tag":"Start here","count":13},{"language":"ar","tag":"Integrations and reference","count":13},{"language":"de","tag":"Integrations and reference","count":13},{"language":"es","tag":"Integrations and reference","count":13},{"language":"fr","tag":"Integrations and reference","count":13},{"language":"he","tag":"Integrations and reference","count":13},{"language":"hi","tag":"Integrations and reference","count":13},{"language":"it","tag":"Integrations and reference","count":13},{"language":"ja","tag":"Integrations and reference","count":13},{"language":"ko","tag":"Integrations and reference","count":13},{"language":"pt-BR","tag":"Integrations and reference","count":13},{"language":"ru","tag":"Integrations and reference","count":13},{"language":"tr","tag":"Integrations and reference","count":13},{"language":"vi","tag":"Integrations and reference","count":13},{"language":"zh","tag":"Integrations and reference","count":13},{"language":"ar","tag":"Start","count":12},{"language":"ar","tag":"Start here","count":12},{"language":"de","tag":"Start","count":12},{"language":"de","tag":"Start here","count":12},{"language":"es","tag":"Start","count":12},{"language":"es","tag":"Start here","count":12},{"language":"fr","tag":"Start","count":12},{"language":"fr","tag":"Start here","count":12},{"language":"he","tag":"Start","count":12},{"language":"he","tag":"Start here","count":12},{"language":"hi","tag":"Start","count":12},{"language":"hi","tag":"Start here","count":12},{"language":"it","tag":"Start","count":12},{"language":"it","tag":"Start here","count":12},{"language":"ja","tag":"Start","count":12},{"language":"ja","tag":"Start here","count":12},{"language":"ko","tag":"Start","count":12},{"language":"ko","tag":"Start here","count":12},{"language":"pt-BR","tag":"Start","count":12},{"language":"pt-BR","tag":"Start here","count":12},{"language":"ru","tag":"Start","count":12},{"language":"ru","tag":"Start here","count":12},{"language":"tr","tag":"Start","count":12},{"language":"tr","tag":"Start here","count":12},{"language":"vi","tag":"Start","count":12},{"language":"vi","tag":"Start here","count":12},{"language":"zh","tag":"Start","count":12},{"language":"zh","tag":"Start here","count":12},{"language":"en","tag":"Understand every run","count":11},{"language":"ar","tag":"Understand every run","count":11},{"language":"de","tag":"Understand every run","count":11},{"language":"es","tag":"Understand every run","count":11},{"language":"fr","tag":"Understand every run","count":11},{"language":"he","tag":"Understand every run","count":11},{"language":"hi","tag":"Understand every run","count":11},{"language":"it","tag":"Understand every run","count":11},{"language":"ja","tag":"Understand every run","count":11},{"language":"ko","tag":"Understand every run","count":11},{"language":"pt-BR","tag":"Understand every run","count":11},{"language":"ru","tag":"Understand every run","count":11},{"language":"tr","tag":"Understand every run","count":11},{"language":"vi","tag":"Understand every run","count":11},{"language":"zh","tag":"Understand every run","count":11},{"language":"ar","tag":"Find and manage failures","count":9},{"language":"de","tag":"Find and manage failures","count":9},{"language":"es","tag":"Find and manage failures","count":9},{"language":"fr","tag":"Find and manage failures","count":9},{"language":"he","tag":"Find and manage failures","count":9},{"language":"hi","tag":"Find and manage failures","count":9},{"language":"it","tag":"Find and manage failures","count":9},{"language":"ja","tag":"Find and manage failures","count":9},{"language":"ko","tag":"Find and manage failures","count":9},{"language":"pt-BR","tag":"Find and manage failures","count":9},{"language":"ru","tag":"Find and manage failures","count":9},{"language":"tr","tag":"Find and manage failures","count":9},{"language":"vi","tag":"Find and manage failures","count":9},{"language":"zh","tag":"Find and manage failures","count":9},{"language":"ar","tag":"Prevent failures","count":8},{"language":"de","tag":"Prevent failures","count":8},{"language":"es","tag":"Prevent failures","count":8},{"language":"fr","tag":"Prevent failures","count":8},{"language":"he","tag":"Prevent failures","count":8},{"language":"hi","tag":"Prevent failures","count":8},{"language":"it","tag":"Prevent failures","count":8},{"language":"ja","tag":"Prevent failures","count":8},{"language":"ko","tag":"Prevent failures","count":8},{"language":"pt-BR","tag":"Prevent failures","count":8},{"language":"ru","tag":"Prevent failures","count":8},{"language":"tr","tag":"Prevent failures","count":8},{"language":"vi","tag":"Prevent failures","count":8},{"language":"zh","tag":"Prevent failures","count":8},{"language":"ar","tag":"Reference","count":7},{"language":"de","tag":"Reference","count":7},{"language":"es","tag":"Reference","count":7},{"language":"fr","tag":"Reference","count":7},{"language":"he","tag":"Reference","count":7},{"language":"hi","tag":"Reference","count":7},{"language":"it","tag":"Reference","count":7},{"language":"ja","tag":"Reference","count":7},{"language":"ko","tag":"Reference","count":7},{"language":"pt-BR","tag":"Reference","count":7},{"language":"ru","tag":"Reference","count":7},{"language":"tr","tag":"Reference","count":7},{"language":"vi","tag":"Reference","count":7},{"language":"zh","tag":"Reference","count":7},{"language":"ar","tag":"Connect your agents","count":6},{"language":"de","tag":"Connect your agents","count":6},{"language":"es","tag":"Connect your agents","count":6},{"language":"fr","tag":"Connect your agents","count":6},{"language":"he","tag":"Connect your agents","count":6},{"language":"hi","tag":"Connect your agents","count":6},{"language":"it","tag":"Connect your agents","count":6},{"language":"ja","tag":"Connect your agents","count":6},{"language":"ko","tag":"Connect your agents","count":6},{"language":"pt-BR","tag":"Connect your agents","count":6},{"language":"ru","tag":"Connect your agents","count":6},{"language":"tr","tag":"Connect your agents","count":6},{"language":"vi","tag":"Connect your agents","count":6},{"language":"zh","tag":"Connect your agents","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":":root{--fpai-pink: #c92251}.dark{--fpai-pink: #e4587d}h1,h2,h3{letter-spacing:-0.025em}#content blockquote{position:relative;margin:1.5rem 0;padding:1.25rem 1.5rem 1.25rem 3.75rem!important;border-left:4px solid var(--fpai-pink)!important;border-radius:0 14px 14px 0;background:#f3f4f6!important;color:inherit!important}#content blockquote::before{content:\"“\";position:absolute;top:0.35rem;left:1rem;color:var(--fpai-pink);font-size:3rem;font-weight:700;line-height:1}#content blockquote p:first-child{margin-top:0}#content blockquote p:last-child{margin-bottom:0}.dark #content blockquote{background:rgba(148, 163, 184, 0.12)!important}.navbar-link a[href=\"https://discord.befailproof.ai\"],.navbar-link a[href=\"https://www.reddit.com/r/failproofai/\"],.navbar-link a[href=\"https://x.com/failproofai\"],.navbar-link a[href=\"https://github.com/FailproofAI/failproofai\"],#topbar-cta-button a[href=\"https://app.befailproof.ai\"]{position:relative}.navbar-link a[href=\"https://discord.befailproof.ai\"]::after,.navbar-link a[href=\"https://www.reddit.com/r/failproofai/\"]::after,.navbar-link a[href=\"https://x.com/failproofai\"]::after,.navbar-link a[href=\"https://github.com/FailproofAI/failproofai\"]::after,#topbar-cta-button a[href=\"https://app.befailproof.ai\"]::after{position:absolute;top:calc(100% + 0.5rem);left:50%;z-index:50;padding:0.35rem 0.55rem;border-radius:0.4rem;background:#111827;color:#fff;font-size:0.75rem;font-weight:500;line-height:1;opacity:0;pointer-events:none;transform:translate(-50%, -0.2rem);transition:opacity 120ms ease, transform 120ms ease}.navbar-link a[href=\"https://discord.befailproof.ai\"]::after{content:\"Join the community\"}.navbar-link a[href=\"https://www.reddit.com/r/failproofai/\"]::after{content:\"Join r/failproofai\"}.navbar-link a[href=\"https://x.com/failproofai\"]::after{content:\"Follow launches\"}.navbar-link a[href=\"https://github.com/FailproofAI/failproofai\"]::after{content:\"Star us!\"}#topbar-cta-button a[href=\"https://app.befailproof.ai\"]::after{content:\"Go to Failproof\"}.navbar-link a[href=\"https://discord.befailproof.ai\"]:hover::after,.navbar-link a[href=\"https://discord.befailproof.ai\"]:focus-visible::after,.navbar-link a[href=\"https://www.reddit.com/r/failproofai/\"]:hover::after,.navbar-link a[href=\"https://www.reddit.com/r/failproofai/\"]:focus-visible::after,.navbar-link a[href=\"https://x.com/failproofai\"]:hover::after,.navbar-link a[href=\"https://x.com/failproofai\"]:focus-visible::after,.navbar-link a[href=\"https://github.com/FailproofAI/failproofai\"]:hover::after,.navbar-link a[href=\"https://github.com/FailproofAI/failproofai\"]:focus-visible::after,#topbar-cta-button a[href=\"https://app.befailproof.ai\"]:hover::after,#topbar-cta-button a[href=\"https://app.befailproof.ai\"]:focus-visible::after{opacity:1;transform:translate(-50%, 0)}img[src^=\"/images/frameworks/\"]{opacity:0.78}.dark img[src^=\"/images/frameworks/\"]{filter:invert(1);opacity:0.7}"}],"page":{"pagePath":"start/quickstart","slug":"/start/quickstart","pageMetadata":{"title":"Quickstart","description":"Capture an agent session, find a failure, and start preventing it.","icon":"zap","href":"/start/quickstart"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Capture an agent session, find a failure, and start preventing it.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{Accordion,Check,CodeBlock,Heading,Step,Steps,Tab,Tabs,Warning}=_components;if(!Accordion)_missingMdxReference(`Accordion`,true);if(!Check)_missingMdxReference(`Check`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Step)_missingMdxReference(`Step`,true);if(!Steps)_missingMdxReference(`Steps`,true);if(!Tab)_missingMdxReference(`Tab`,true);if(!Tabs)_missingMdxReference(`Tabs`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`This quickstart gets one machine reporting sessions, runs an audit, and deploys a policy. Use the skill to set Failproof up, or follow the manual steps.`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Which path is yours?`}),` If your agent runs in one of the 12 supported `,_jsx(_components.a,{href:`/reference/harnesses`,children:`harnesses`}),` — a coding CLI, or a gateway like Hermes or OpenClaw — follow the steps below; you need Node.js 20.9 or later. If your agent has no harness, instrument it with the `,_jsx(_components.a,{href:`/reference/custom-agents`,children:`Python SDK`}),` for tracing and audits, then rejoin at `,_jsx(_components.a,{href:`/start/first-audit`,children:`Run your first failure check`}),`; enforcement on that path needs a hook in your runtime.`]}),`\n`,_jsxs(Tabs,{children:[_jsx(Tab,{title:`Use the skill`,id:`use-the-skill`,children:_jsxs(Steps,{children:[_jsx(Step,{title:`Install the Failproof AI skills`,children:_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`npx`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` skills`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` add`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` FailproofAI/skills`})]}),`\n`]})})})}),_jsxs(Step,{title:`Ask your agent to set everything up`,children:[_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Set up Failproof AI for this project, connect this machine, install the right hooks and policies, and verify that a session arrives.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),_jsxs(_components.p,{children:[`Your agent inspects the project, chooses the relevant integration, performs the setup, and verifies it. See the `,_jsx(_components.a,{href:`https://github.com/FailproofAI/skills`,children:`FailproofAI skills repository`}),` for individual skills and advanced installation options.`]})]})]})}),_jsxs(Tab,{title:`Manual setup`,id:`manual-setup`,\"data-child-heading-ids\":`[\"install\"]`,children:[_jsx(Heading,{level:`2`,id:`install`,children:`Install`}),_jsxs(Steps,{children:[_jsxs(Step,{title:`Install and connect Failproof AI`,children:[_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`npm`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` install`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -g`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` failproofai`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`failproofai`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` config`})]}),`\n`]})})}),_jsx(_components.p,{children:`That one command is the whole of setup: it installs the local daemon (root once), wires hooks into every agent CLI it finds, and connects this machine to Cloud.`}),_jsxs(_components.p,{children:[`At `,_jsx(_components.strong,{children:`Connect to cloud`}),`, setup starts logging you in to FailproofAI Cloud straight away (press Tab for the other options: paste an API key, or use open source). It opens a link in your browser (over SSH, or on a machine with no display, it prints the link so you can open it on any device). Sign up or sign in, confirm the org — or create one right there — and click `,_jsx(_components.strong,{children:`Authorize`}),`. The key’s name and permissions are set for you. You do not need an account beforehand.`]}),_jsxs(_components.p,{children:[`The terminal notices on its own and shows who approved it and for which org. Confirm the agents to trace, and setup finishes. The machine’s key is created only at that point, after the daemon is installed, so a run you abandon leaves no key behind; it appears under `,_jsx(_components.strong,{children:`Administration → Keys`}),` marked `,_jsx(_components.strong,{children:`cli login`}),`, where you can revoke it.`]}),_jsxs(Accordion,{title:`No browser or terminal at hand? Use a key (CI, containers, provisioning scripts)`,id:`no-browser-or-terminal-at-hand-use-a-key-ci-containers-provisioning-scripts`,children:[_jsxs(_components.p,{children:[`In the `,_jsx(_components.a,{href:`https://app.befailproof.ai`,children:`Failproof AI dashboard`}),`, go to `,_jsx(_components.strong,{children:`Administration → Keys`}),` and create a key with `,_jsx(_components.code,{children:`events:add`}),` and `,_jsx(_components.code,{children:`policies:pull`}),`. If you plan to use `,_jsx(_components.a,{href:`/reference/jev-cloud`,children:`Jev through FailproofAI Cloud`}),`, choose the `,_jsx(_components.strong,{children:`machine`}),` preset, which also grants `,_jsx(_components.code,{children:`jev:evaluate`}),`. Copy the one-time secret and read it into a shell on the target machine — `,_jsx(_components.code,{children:`read -s`}),` takes it at a prompt that does not echo:`]}),_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`read`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -rs`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` FAILPROOFAI_KEY`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` \u0026\u0026 `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`export`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` FAILPROOFAI_KEY`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`FAILPROOFAI_CLOUD_TOKEN`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$FAILPROOFAI_KEY`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:` failproofai`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` config`})]}),`\n`]})})}),_jsxs(_components.p,{children:[`Passing the key through the environment rather than `,_jsx(_components.code,{children:`--token`}),` keeps it out of `,_jsx(_components.code,{children:`ps`}),`, where every user on the machine can read a command’s arguments. It does not keep it out of shell history — reading it with `,_jsx(_components.code,{children:`read -s`}),` is what does that. In CI, inject it as a masked secret and keep shell tracing (`,_jsx(_components.code,{children:`set -x`}),`) off, or the trace prints it. In an interactive run you can also pick `,_jsx(_components.strong,{children:`Paste an API key`}),` at `,_jsx(_components.strong,{children:`Connect to cloud`}),` instead.`]})]}),_jsxs(_components.p,{children:[`Session transcripts are sent by default. Add `,_jsx(_components.code,{children:`--no-transcripts`}),` to report hook activity and policy decisions without transcript content.`]}),_jsx(Warning,{children:_jsxs(_components.p,{children:[`Do not reach for `,_jsx(_components.code,{children:`failproofai config --connect \u003curl>`}),` here. That flag enrols a machine that is `,_jsx(_components.strong,{children:`already`}),` set up and returns straight after — no daemon, no hooks — so the machine would appear in Cloud while collecting and enforcing nothing.`]})}),_jsx(_components.p,{children:`If this machine already has agent history, preview and import the last seven days, then wait for delivery to finish. Skip this step on a new machine.`}),_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`failproofai`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` backfill`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --since`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 7d`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --dry-run`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`failproofai`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` backfill`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --since`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 7d`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`failproofai`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` flush`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --wait`})]}),`\n`]})})}),_jsxs(_components.p,{children:[`Open `,_jsx(_components.strong,{children:`Sessions`}),` in Failproof AI and select an imported session.`]})]}),_jsxs(Step,{title:`Attach Failproof AI to a harness`,children:[_jsxs(_components.p,{children:[`The previous step already wired every agent CLI it detected. Re-run it for one harness explicitly when you need to, or to add a harness installed afterwards. Every one of the 12 is a valid `,_jsx(_components.code,{children:`--cli`}),` value — `,_jsx(_components.code,{children:`claude`}),`, `,_jsx(_components.code,{children:`codex`}),`, `,_jsx(_components.code,{children:`copilot`}),`, `,_jsx(_components.code,{children:`cursor`}),`, `,_jsx(_components.code,{children:`opencode`}),`, `,_jsx(_components.code,{children:`pi`}),`, `,_jsx(_components.code,{children:`hermes`}),`, `,_jsx(_components.code,{children:`openclaw`}),`, `,_jsx(_components.code,{children:`factory`}),`, `,_jsx(_components.code,{children:`devin`}),`, `,_jsx(_components.code,{children:`antigravity`}),`, `,_jsx(_components.code,{children:`goose`}),`.`]}),_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`failproofai`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` policies`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --install`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --cli`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` claude`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --scope`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` user`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # a coding CLI`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`failproofai`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` policies`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --install`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --cli`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` hermes`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --scope`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` user`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # a Slack/Telegram gateway`})]}),`\n`]})})}),_jsxs(_components.p,{children:[`Blocking a tool call before it runs is verified on all 12. Turn-end gates are verified on 8 — see `,_jsx(_components.a,{href:`/reference/harnesses#enforcement-capability`,children:`enforcement capability`}),` for the per-harness matrix.`]})]}),_jsxs(Step,{title:`Choose what to enforce`,children:[_jsx(_components.p,{children:`Wiring hooks enables no policy. Setup deliberately picks none — that decision is yours — so take a pack:`}),_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`failproofai`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` policies`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` add`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` FailproofAI/policies`})]}),`\n`]})})}),_jsx(_components.p,{children:`The pack is fetched from its GitHub release, checksum-verified, and pinned to the exact tag it resolved. It carries 39 policies and switches on the 10 its manifest marks as safe to enable unattended. Use them to see local policy decisions and try enforcement before Failproof AI audits your sessions and writes policies for your agents.`}),_jsxs(_components.p,{children:[`Read any pack before taking it with `,_jsx(_components.code,{children:`failproofai policies show \u003cowner>/\u003crepo>`}),`, and see `,_jsx(_components.a,{href:`/policies/packs`,children:`policy packs`}),` for taking only part of one.`]}),_jsxs(_components.p,{children:[`Until this runs, the only thing enforcing is `,_jsx(_components.code,{children:`block-failproofai-commands`}),` — the always-on guard that stops an agent switching Failproof AI off. `,_jsx(_components.code,{children:`failproofai policies`}),` lists what is on.`]})]}),_jsx(Step,{title:`Audit the behavior`,children:_jsxs(_components.p,{children:[`Follow `,_jsx(_components.a,{href:`/start/first-audit`,children:`Run your first failure check`}),`. Use a concrete goal such as “find sessions where the agent retried a failing tool without changing its approach.”`]})}),_jsx(Step,{title:`Prevent the failure`,children:_jsxs(_components.p,{children:[`Follow `,_jsx(_components.a,{href:`/start/first-policy`,children:`Prevent your first failure with a policy`}),`. Start in observe mode, inspect matches, then enforce the reviewed version.`]})})]}),_jsx(Check,{children:_jsxs(_components.p,{children:[`Run `,_jsx(_components.code,{children:`failproofai config --status`}),`. A healthy setup reports the cloud connection, daemon state, and whether enforcement is paused.`]})})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`jev-setup`,children:`Jev setup`}),`\n`,_jsxs(_components.p,{children:[`Use `,_jsx(_components.a,{href:`/start/use-jev`,children:`Jev`}),` to score finished sessions against a question with known answers, or to review tool calls in context before they run. The `,_jsx(_components.strong,{children:`Use Jev`}),` page has both setup paths.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Quickstart","description":"Capture an agent session, find a failure, and start preventing it.","icon":"zap","href":"/start/quickstart"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Install","slug":"install","depth":2,"children":[],"tabId":"manual-setup"},{"title":"Jev setup","slug":"jev-setup","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/exosphere/86fd84cc0563b6f3/stars.js","/_mintlify/custom/exosphere/3e9809a158d7fc0b/reo.js"],"subdomain":"exosphere","siteName":"Failproof AI","title":"Quickstart - Failproof AI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/start/quickstart","matchLevel":0},"zh":{"href":"/zh/start/quickstart","matchLevel":1},"ja":{"href":"/ja/start/quickstart","matchLevel":1},"ko":{"href":"/ko/start/quickstart","matchLevel":1},"es":{"href":"/es/start/quickstart","matchLevel":1},"pt-BR":{"href":"/pt-br/start/quickstart","matchLevel":1},"de":{"href":"/de/start/quickstart","matchLevel":1},"fr":{"href":"/fr/start/quickstart","matchLevel":1},"ru":{"href":"/ru/start/quickstart","matchLevel":1},"hi":{"href":"/hi/start/quickstart","matchLevel":1},"tr":{"href":"/tr/start/quickstart","matchLevel":1},"vi":{"href":"/vi/start/quickstart","matchLevel":1},"it":{"href":"/it/start/quickstart","matchLevel":1},"ar":{"href":"/ar/start/quickstart","matchLevel":1},"he":{"href":"/he/start/quickstart","matchLevel":1}}},"lastModified":"2026-10-25T01:22:19.215Z","originalFileLocation":"start/quickstart.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Capture an agent session, find a failure, and start preventing it.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Failproof AI\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/exosphere/jZWjNNy57lpILUrG/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/exosphere/jZWjNNy57lpILUrG/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/exosphere/jZWjNNy57lpILUrG/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/exosphere/jZWjNNy57lpILUrG/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/exosphere/jZWjNNy57lpILUrG/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/exosphere/jZWjNNy57lpILUrG/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/exosphere/jZWjNNy57lpILUrG/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/exosphere/jZWjNNy57lpILUrG/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/exosphere/jZWjNNy57lpILUrG/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Quickstart - Failproof AI\">\u003cmeta data-mint-head property=\"og:description\" content=\"Capture an agent session, find a failure, and start preventing it.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Failproof AI\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.befailproof.ai/start/quickstart\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://exosphere.mintlify.site/_mintlify/api/og/v2?division=Start+here\u0026amp;title=Quickstart\u0026amp;description=Capture+an+agent+session%2C+find+a+failure%2C+and+start+preventing+it.\u0026amp;theme=cebdc1f0592da2cd408854e5\u0026amp;signature=44332985bf59a5f69b4ecde1b0fcf25c0dc14569ba27ca6b3c13ad57d6c56646\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Quickstart - Failproof AI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Capture an agent session, find a failure, and start preventing it.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://exosphere.mintlify.site/_mintlify/api/og/v2?division=Start+here\u0026amp;title=Quickstart\u0026amp;description=Capture+an+agent+session%2C+find+a+failure%2C+and+start+preventing+it.\u0026amp;theme=cebdc1f0592da2cd408854e5\u0026amp;signature=44332985bf59a5f69b4ecde1b0fcf25c0dc14569ba27ca6b3c13ad57d6c56646\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/exosphere/jZWjNNy57lpILUrG/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Failproof AI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#c92251\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.befailproof.ai/start/quickstart\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/start/quickstart.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.befailproof.ai/start/quickstart\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://docs.befailproof.ai/zh/start/quickstart\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ja\" href=\"https://docs.befailproof.ai/ja/start/quickstart\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ko\" href=\"https://docs.befailproof.ai/ko/start/quickstart\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"es\" href=\"https://docs.befailproof.ai/es/start/quickstart\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt-BR\" href=\"https://docs.befailproof.ai/pt-br/start/quickstart\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"de\" href=\"https://docs.befailproof.ai/de/start/quickstart\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://docs.befailproof.ai/fr/start/quickstart\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ru\" href=\"https://docs.befailproof.ai/ru/start/quickstart\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"hi\" href=\"https://docs.befailproof.ai/hi/start/quickstart\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"tr\" href=\"https://docs.befailproof.ai/tr/start/quickstart\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"vi\" href=\"https://docs.befailproof.ai/vi/start/quickstart\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"it\" href=\"https://docs.befailproof.ai/it/start/quickstart\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ar\" href=\"https://docs.befailproof.ai/ar/start/quickstart\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"he\" href=\"https://docs.befailproof.ai/he/start/quickstart\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.befailproof.ai/start/quickstart\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.befailproof.ai/#organization\",\"name\":\"Failproof AI\",\"url\":\"https://docs.befailproof.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/exosphere/63Tp--IVddVBndpp/logo/Failproof_AI_logo_light.png?fit=max\u0026auto=format\u0026n=63Tp--IVddVBndpp\u0026q=85\u0026s=5231ac600a18d7ad299834e4a880f6e0\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.befailproof.ai#website\",\"name\":\"Failproof AI\",\"url\":\"https://docs.befailproof.ai\",\"publisher\":{\"@id\":\"https://docs.befailproof.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.befailproof.ai/start/quickstart#webpage\",\"url\":\"https://docs.befailproof.ai/start/quickstart\",\"name\":\"Quickstart\",\"description\":\"Capture an agent session, find a failure, and start preventing it.\",\"dateModified\":\"2026-10-25T01:22:19.215Z\",\"isPartOf\":{\"@id\":\"https://docs.befailproof.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.befailproof.ai/start/quickstart#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.befailproof.ai/start/quickstart#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Start here\",\"item\":\"https://docs.befailproof.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Quickstart\",\"item\":\"https://docs.befailproof.ai/start/quickstart\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.befailproof.ai/start/quickstart#article\",\"headline\":\"Quickstart\",\"name\":\"Quickstart\",\"description\":\"Capture an agent session, find a failure, and start preventing it.\",\"url\":\"https://docs.befailproof.ai/start/quickstart\",\"mainEntityOfPage\":{\"@id\":\"https://docs.befailproof.ai/start/quickstart#webpage\"},\"dateModified\":\"2026-10-25T01:22:19.215Z\",\"publisher\":{\"@id\":\"https://docs.befailproof.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.befailproof.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Failproof AI\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Failproof AI\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/start/quickstart.md","siteName":"Failproof AI","nav":{"global":{"anchors":[{"anchor":"Support","icon":"mail","href":"mailto:support@befailproof.ai"}]},"languages":[{"language":"en","tabs":[{"tab":"Start","icon":"rocket","groups":[{"group":"Start here","pages":[{"title":"Make your agent failproof","description":"Observability and enforcement for every harness your agents run in — coding CLIs, chat gateways, self-hosted assistants, and your own instrumented agents.","icon":"shield-check","href":""},{"title":"Quickstart","icon":"zap","href":"/start/quickstart"},{"title":"Agent harnesses","description":"Capture sessions and enforce policies across all 12 supported agent harnesses.","icon":"plug-zap","href":"/reference/harnesses"},{"title":"Failproof Assistant","icon":"message-square-text","href":"/sessions/assistant"},{"title":"Run your first failure check","icon":"scan-search","href":"/start/first-audit"},{"title":"Prevent your first failure with a policy","icon":"shield-check","href":"/start/first-policy"},{"title":"Choose your setup","icon":"waypoints","href":"/start/setup"},{"title":"Core concepts","icon":"boxes","href":"/start/concepts"},{"title":"Use Jev","icon":"sparkles","href":"/start/use-jev"},{"group":"Starter templates","expanded":false,"pages":[{"title":"Custom agents","icon":"code","href":"/start/quickstarts/custom-agents"},{"title":"LangChain and LangGraph","icon":"https://mintlify.s3.us-west-1.amazonaws.com/exosphere/images/frameworks/langchain.svg","href":"/start/quickstarts/langchain"},{"title":"CrewAI","icon":"https://mintlify.s3.us-west-1.amazonaws.com/exosphere/images/frameworks/crewai.svg","href":"/start/quickstarts/crewai"},{"title":"LlamaIndex","icon":"https://mintlify.s3.us-west-1.amazonaws.com/exosphere/images/frameworks/llamaindex.svg","href":"/start/quickstarts/llamaindex"},{"title":"Pydantic AI","icon":"https://mintlify.s3.us-west-1.amazonaws.com/exosphere/images/frameworks/pydantic-ai.svg","href":"/start/quickstarts/pydantic-ai"}]}]}]},{"tab":"Trace Agents","icon":"route","pages":[{"title":"Trace Agents","href":"/sessions/overview"}]},{"tab":"Find failures","icon":"scan-search","pages":[{"title":"Find failures","href":"/evaluations/overview"}]},{"tab":"Prevent failures","icon":"shield-check","pages":[{"title":"Prevent failures","href":"/policies/overview"}]},{"tab":"Admin","icon":"settings-2","pages":[{"title":"Admin","href":"/admin/overview"}]},{"tab":"Integrations and reference","icon":"braces","pages":[{"title":"Integrations and reference","href":"/reference/overview"}]}]},{"language":"zh","pages":[{"title":"zh","href":"/zh/start/quickstart"}]},{"language":"ja","pages":[{"title":"ja","href":"/ja/start/quickstart"}]},{"language":"ko","pages":[{"title":"ko","href":"/ko/start/quickstart"}]},{"language":"es","pages":[{"title":"es","href":"/es/start/quickstart"}]},{"language":"pt-BR","pages":[{"title":"pt-BR","href":"/pt-br/start/quickstart"}]},{"language":"de","pages":[{"title":"de","href":"/de/start/quickstart"}]},{"language":"fr","pages":[{"title":"fr","href":"/fr/start/quickstart"}]},{"language":"ru","pages":[{"title":"ru","href":"/ru/start/quickstart"}]},{"language":"hi","pages":[{"title":"hi","href":"/hi/start/quickstart"}]},{"language":"tr","pages":[{"title":"tr","href":"/tr/start/quickstart"}]},{"language":"vi","pages":[{"title":"vi","href":"/vi/start/quickstart"}]},{"language":"it","pages":[{"title":"it","href":"/it/start/quickstart"}]},{"language":"ar","pages":[{"title":"ar","href":"/ar/start/quickstart"}]},{"language":"he","pages":[{"title":"he","href":"/he/start/quickstart"}]}]},"basePath":"","title":"Quickstart - Failproof AI","buildId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","deploymentId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","dynamics":[],"chunks":[]}