Show agent-facing usage that matches the installed Entire CLI.
Show coding agents which Entire command to use and retrieve exact usage for the installed CLI.Unlike static command documentation, agent-help generates its output from the installed Entire binary. This helps agents avoid guessing commands or flags that may differ between CLI versions.
entire agent-help [COMMAND...] [flags]
With no command, agent-help prints a high-level map of available commands and when to use them:
entire agent-help
The output also identifies the repository detected from the Git remote. You do not need to provide the repository name when working in the current repository.
Get Help for a Command
Pass a command or nested command path to see its description, subcommands, and currently installed flags:
The command map only includes commands available in the current installation and repository. Commands that are deprecated, internal, or unavailable for the repository are omitted.
Get Structured Output
Use --json when an agent or script needs structured output:
The JSON response includes the command name, short and long descriptions, detected repository, subcommands, and flags when applicable.
Flags
Flag
Description
--json
Emit structured JSON instead of text
--help, -h
Show help for agent-help
entire agent-help describes the CLI installed on your machine. Use this command as the source of truth when its output differs from static documentation.
Was this page helpful?
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Entire","colors":{"primary":"#372aac","light":"#7c86ff","dark":"#312c85"},"logo":{"light":"https://mintcdn.com/entire/dU84oUx3gFbNHZ8_/logo/light.svg?fit=max\u0026auto=format\u0026n=dU84oUx3gFbNHZ8_\u0026q=85\u0026s=6ce790665b11c249fbf9d14a33f846c4","dark":"https://mintcdn.com/entire/dU84oUx3gFbNHZ8_/logo/dark.svg?fit=max\u0026auto=format\u0026n=dU84oUx3gFbNHZ8_\u0026q=85\u0026s=4499c6eb37e0fdff05bed2f478dfe874","href":"https://entire.com"},"favicon":"https://mintcdn.com/entire/dU84oUx3gFbNHZ8_/favicon.svg?fit=max\u0026auto=format\u0026n=dU84oUx3gFbNHZ8_\u0026q=85\u0026s=dbeaa850f719267b132dbd97e5922ef6","api":{"playground":{"display":"simple"}},"background":{"color":{"light":"#f6f6f6","dark":"#161616"}},"navbar":{"links":[{"href":"https://status.entire.io/","label":"Status"}],"primary":{"type":"button","label":"Quickstart","href":"/quickstart"}},"footer":{"socials":{"x":"https://x.com/goentire","github":"https://github.com/entireio/cli","discord":"https://discord.gg/jZJs3Tue4S","linkedin":"https://www.linkedin.com/company/goentire","website":"https://entire.com/blog"}},"fonts":{"heading":{"family":"Entire Headline NEW","weight":750,"source":"fonts/entire-headline-semibold.woff2","format":"woff2"}},"integrations":{"posthog":{"apiKey":"phc_zhl0ztZpXaRWYhENKulB1UU8Kqz64twJCNw9GffEl4N","apiHost":"https://42.entire.io"}},"contextual":{"options":["copy","view","claude","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"GitHub","icon":"github","href":"https://github.com/entireio"},{"anchor":"Discord","icon":"discord","href":"https://discord.gg/jZJs3Tue4S"},{"anchor":"Blog","icon":"newspaper","href":"https://entire.com/blog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"entire","hasAudioNarration":false,"actualSubdomain":"entire","customDomains":["docs.entire.com"],"gitSource":{"type":"github","owner":"entireio","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afc0b4470e6e056bd1b5e64","clientVersion":"0.0.4167","searchFilterCounts":[{"language":"default","tag":"API Reference","count":112},{"language":"default","tag":"Documentation","count":88},{"language":"default","tag":"Guides","count":72},{"language":"default","tag":"Trails","count":55},{"language":"default","tag":"CLI Reference","count":41},{"language":"default","tag":"Commands","count":41},{"language":"default","tag":"Accounts and projects","count":27},{"language":"default","tag":"Git","count":25},{"language":"default","tag":"Session Storage","count":17},{"language":"default","tag":"Discussions","count":14}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"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":"style.css","content":"@font-face{font-family:\"Entire Headline NEW\";src:url(\"/fonts/entire-headline-semibold.woff2\") format(\"woff2\");font-weight:100 900;font-style:normal;font-display:swap}@font-face{font-family:\"Entire Headline NEW\";src:url(\"/fonts/entire-headline-semibolditalic.woff2\") format(\"woff2\");font-weight:100 900;font-style:italic;font-display:swap}@font-face{font-family:\"Entire Mono\";src:url(\"/fonts/entire-mono-regular.woff2\") format(\"woff2\");font-weight:400;font-style:normal;font-display:swap}@font-face{font-family:\"Entire Mono\";src:url(\"/fonts/entire-mono-bold.woff2\") format(\"woff2\");font-weight:700;font-style:normal;font-display:swap}:root{--entire-accent: #372aac;--entire-accent-hover: #312c85;--entire-bg: #f6f6f6;--entire-surface-sunken: #f2f2f2;--entire-surface-raised: #fcfcfc;--entire-surface-floating: #ffffff;--entire-surface-hover: rgb(0 0 0 / 0.035);--entire-surface-selected: rgb(0 0 0 / 0.06);--entire-border: rgb(10 10 10 / 0.12);--entire-border-subtle: rgb(10 10 10 / 0.08);--entire-text: #0f0f0f;--entire-muted: #707070;--entire-disabled: #959595;--entire-code-bg: #f2f2f2;--entire-font-sans: ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, \"Segoe UI\", sans-serif;--entire-font-headline: \"Entire Headline NEW\", var(--entire-font-sans);--entire-font-mono: \"Entire Mono\", ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, monospace}.dark{--entire-accent: #7c86ff;--entire-accent-hover: #a3b3ff;--entire-bg: #161616;--entire-surface-sunken: #111111;--entire-surface-raised: #1c1c1c;--entire-surface-floating: #222222;--entire-surface-hover: rgb(255 255 255 / 0.06);--entire-surface-selected: rgb(255 255 255 / 0.08);--entire-border: rgb(250 250 250 / 0.1);--entire-border-subtle: rgb(250 250 250 / 0.08);--entire-text: #f3f3f3;--entire-muted: #b9b9b9;--entire-disabled: #707070;--entire-code-bg: #222222}html,body{background:var(--entire-bg)!important}body{color:var(--entire-text);font-family:var(--entire-font-sans);-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}#navbar,#header{background:color-mix(in srgb, var(--entire-bg) 92%, transparent)!important;border-color:var(--entire-border-subtle)!important}#topbar-cta-button svg{transform:scale(1.5);color:#ffffff}#topbar-cta-button svg path{stroke-width:2}#sidebar,#sidebar-content{background:var(--entire-bg)!important;border-color:var(--entire-border-subtle)!important}#sidebar a,#sidebar button{border-radius:8px}#sidebar a:hover,#sidebar button:hover{background:var(--entire-surface-hover)!important}#content-area,#content{color:var(--entire-text)}#content-area h1,#content-area h2,#content-area h3,#content-area h4,#page-title{color:var(--entire-text);font-family:var(--entire-font-headline);font-weight:750;letter-spacing:0}#content-area p,#content-area li,#content-area td{color:var(--entire-muted)}#content-area strong,#content-area th{color:var(--entire-text)}#content-area a{color:var(--entire-accent);text-underline-offset:3px}#content-area a:hover{color:var(--entire-accent-hover)}#content-area code,#content-area pre,#content-area kbd{font-family:var(--entire-font-mono)}#content-area :not(pre)>code,#content-area kbd{background:var(--entire-code-bg);border:1px solid var(--entire-border-subtle);border-radius:4px;color:var(--entire-text)}#content-area pre,#content-area table,#content-area blockquote{border-color:var(--entire-border-subtle)!important}#content-area table{background:transparent}#content-area table td{min-width:0}#content-area blockquote{color:var(--entire-muted)}@media (min-width: 1024px){#header #page-title+#page-context-menu{display:flex!important}#header>#page-context-menu{display:none!important}}.el-landing{--el-bg: var(--entire-bg);--el-panel: var(--entire-surface-raised);--el-card: var(--entire-surface-floating);--el-card-hover: color-mix(in srgb, var(--entire-accent) 7%, var(--entire-surface-floating));--el-border: var(--entire-border-subtle);--el-text: var(--entire-text);--el-muted: var(--entire-muted);--el-accent: var(--entire-accent);--el-accent-dark: var(--entire-accent-hover);max-width:1040px;margin:0;padding-top:24px;color:var(--el-text)}.dark .el-landing{--el-card-hover: color-mix(in srgb, var(--entire-accent) 10%, var(--entire-surface-floating))}html[data-current-path=\"/\"] #page-title{font-size:28px!important;line-height:34px!important}html[data-current-path=\"/\"] #header .text-lg{font-size:16px!important;line-height:24px!important}.el-landing h1,.el-landing h2,.el-section-title,.el-landing p{margin:0}.el-landing a{color:inherit;text-decoration:none}.el-kicker{display:inline-flex;align-items:center;color:var(--el-accent);font-family:var(--entire-font-mono);font-size:11.5px;font-weight:700;line-height:1.3;margin-bottom:10px;text-transform:uppercase}.el-start,.el-surface{background:var(--el-panel);border:1px solid var(--el-border);border-radius:10px;margin:0 0 38px;padding:24px}.el-start{display:grid;grid-template-columns:minmax(0, 0.95fr) minmax(0, 1.45fr);gap:32px;align-items:start}.el-section-title{color:var(--el-text);display:block!important;font-family:var(--entire-font-headline);font-size:24px!important;font-weight:750;line-height:1.2!important;margin:0 0 7px;text-wrap:balance}.el-start__header p,.el-section__header p,.el-surface p{color:var(--el-muted);font-size:14px;line-height:1.5;max-width:620px}.el-start__grid{display:grid;gap:12px}.el-start-card{display:grid;grid-template-columns:44px minmax(0, 1fr);gap:14px;align-items:center;min-height:82px;padding:18px;background:var(--el-card);border:1px solid var(--el-border);border-radius:8px;transition:border-color 0.15s ease, background 0.15s ease}.el-start-card:hover{background:var(--el-card-hover);border-color:var(--el-accent)}.el-step{display:inline-flex;align-items:center;justify-content:center;width:38px;height:38px;border-radius:8px;background:color-mix(in srgb, var(--el-accent) 12%, transparent);color:var(--el-accent);font-family:var(--entire-font-mono);font-size:13px;font-weight:800}.el-start-card__title,.el-surface-card__title{display:block;color:var(--el-text);font-size:14px;font-weight:750;line-height:1.3;margin-bottom:3px}.el-start-card__desc,.el-surface-card__desc{display:block;color:var(--el-muted);font-size:12px;line-height:1.4}.el-section{margin:0 0 38px}.el-section__header{margin:0 0 16px}.el-grid{display:grid;gap:12px}.el-grid--3{grid-template-columns:repeat(3, minmax(0, 1fr))}.el-grid--2{grid-template-columns:repeat(2, minmax(0, 1fr))}.el-grid--4{grid-template-columns:repeat(4, minmax(0, 1fr))}.el-card{display:flex;flex-direction:column;gap:9px;min-height:144px;padding:16px;background:var(--el-card);border:1px solid var(--el-border);border-radius:7px;transition:border-color 0.15s ease, background 0.15s ease, transform 0.15s ease}.el-card:hover{background:var(--el-card-hover);border-color:var(--el-accent);transform:translateY(-1px)}.el-card svg{flex:0 0 auto}.el-card__title{color:var(--el-text);font-size:14.5px;font-weight:750;line-height:1.3}.el-card__desc{color:var(--el-muted);font-size:12.5px;line-height:1.45}.el-card--compact{min-height:126px}.el-landing .el-card svg.icon,.el-landing .el-surface-card svg.icon{color:var(--el-accent);background-color:var(--el-accent)}.el-badge{display:inline-flex;align-items:center;padding:2px 7px;border-radius:999px;background:color-mix(in srgb, var(--el-accent) 12%, transparent);color:var(--el-accent)!important;font-family:var(--entire-font-mono);font-size:11px!important;font-weight:800;line-height:1.2!important;vertical-align:middle}.el-surface{display:grid;grid-template-columns:minmax(0, 0.9fr) minmax(0, 1.25fr);gap:22px;align-items:start}.el-surface__grid{display:grid;gap:12px}.el-surface-card{display:grid;grid-template-columns:26px minmax(0, 1fr);gap:12px;align-items:start;padding:15px;background:var(--el-card);border:1px solid var(--el-border);border-radius:7px;transition:border-color 0.15s ease, background 0.15s ease}.el-surface-card:hover{background:var(--el-card-hover);border-color:var(--el-accent)}.el-inline-link{grid-column:2;display:inline-flex;align-items:center;gap:7px;width:fit-content;color:var(--el-accent)!important;font-size:14px;font-weight:700}.el-section--resources{padding-bottom:18px}.el-resource-grid{display:grid;grid-template-columns:repeat(4, minmax(0, 1fr));gap:10px}.el-resource-grid a{display:flex;align-items:center;min-height:50px;padding:13px;background:var(--el-card);border:1px solid var(--el-border);border-radius:7px;color:var(--el-text);font-size:13px;font-weight:700;transition:border-color 0.15s ease, background 0.15s ease}.el-resource-grid a:hover{background:var(--el-card-hover);border-color:var(--el-accent)}@media (max-width: 1050px){.el-grid--3,.el-grid--4,.el-resource-grid{grid-template-columns:repeat(2, minmax(0, 1fr))}}@media (max-width: 820px){.el-landing{padding-top:18px}.el-start,.el-surface{grid-template-columns:1fr;padding:22px}.el-inline-link{grid-column:1}}@media (max-width: 620px){.el-grid--2,.el-grid--3,.el-grid--4,.el-resource-grid{grid-template-columns:1fr}}#content-area table.endpoint-index{display:table;width:100%;table-layout:fixed;border-collapse:collapse}#content-area .endpoint-index col:first-child{width:60%}#content-area .endpoint-index col:last-child{width:40%}#content-area .endpoint-index th,#content-area .endpoint-index td{vertical-align:top;padding:16px 0;text-align:left;border-bottom:1px solid var(--entire-border-subtle)}#content-area .endpoint-index th{font-size:13px;font-weight:500;color:var(--entire-muted)}#content-area .endpoint-index td:first-child{padding-right:24px}#content-area .endpoint-index .endpoint-cell{display:flex;align-items:baseline;gap:10px;min-width:0}#content-area .endpoint-index .endpoint-method{flex-shrink:0;min-width:43px;text-align:center;padding:2px 5px;border-radius:5px;color:var(--entire-accent);background:color-mix(in srgb, var(--entire-accent) 10%, transparent);font:500 11px/1.65 var(--entire-font-mono)}#content-area .endpoint-index .endpoint-path{color:var(--entire-text);font:400 13px/1.8 var(--entire-font-mono);min-width:0;white-space:normal;word-break:normal;overflow-wrap:normal}#content-area .endpoint-index .endpoint-segment{white-space:nowrap}#content-area .endpoint-index td:last-child a{font-size:14px;line-height:1.6}@media (max-width: 520px){#content-area table.endpoint-index,#content-area .endpoint-index tbody{display:block}#content-area .endpoint-index thead{position:absolute;width:1px;height:1px;padding:0;overflow:hidden;clip-path:inset(50%);white-space:nowrap}#content-area .endpoint-index tbody tr{display:block;padding:16px 0;border-bottom:1px solid var(--entire-border-subtle)}#content-area .endpoint-index td:first-child,#content-area .endpoint-index td:last-child{display:block;width:100%;border:0;padding:0}#content-area .endpoint-index td:last-child{padding-left:53px;margin-top:8px}}"}],"page":{"pagePath":"cli-reference/agent-help","slug":"/cli-reference/agent-help","pageMetadata":{"title":"agent-help","description":"Show agent-facing usage that matches the installed Entire CLI.","href":"/cli-reference/agent-help"},"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: \"Show agent-facing usage that matches the installed Entire CLI.\"\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={code:`code`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Show coding agents which Entire command to use and retrieve exact usage for the installed CLI.`}),`\n`,_jsxs(_components.p,{children:[`Unlike static command documentation, `,_jsx(_components.code,{children:`agent-help`}),` generates its output from the installed Entire binary. This helps agents avoid guessing commands or flags that may differ between CLI versions.`]}),`\n`,_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:`entire`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` agent-help`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` [COMMAND...] [flags]`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`With no command, `,_jsx(_components.code,{children:`agent-help`}),` prints a high-level map of available commands and when to use them:`]}),`\n`,_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:`entire`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` agent-help`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`The output also identifies the repository detected from the Git remote. You do not need to provide the repository name when working in the current repository.`}),`\n`,_jsx(Heading,{level:`2`,id:`get-help-for-a-command`,children:`Get Help for a Command`}),`\n`,_jsx(_components.p,{children:`Pass a command or nested command path to see its description, subcommands, and currently installed flags:`}),`\n`,_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:`entire`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` agent-help`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` status`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`entire`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` agent-help`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` checkpoint`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` explain`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`entire`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` agent-help`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` session`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` resume`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`The command map only includes commands available in the current installation and repository. Commands that are deprecated, internal, or unavailable for the repository are omitted.`}),`\n`,_jsx(Heading,{level:`2`,id:`get-structured-output`,children:`Get Structured Output`}),`\n`,_jsxs(_components.p,{children:[`Use `,_jsx(_components.code,{children:`--json`}),` when an agent or script needs structured output:`]}),`\n`,_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:`entire`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` agent-help`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --json`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`entire`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` agent-help`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` checkpoint`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` explain`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --json`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`The JSON response includes the command name, short and long descriptions, detected repository, subcommands, and flags when applicable.`}),`\n`,_jsx(Heading,{level:`2`,id:`flags`,children:`Flags`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Flag`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--json`})}),_jsx(_components.td,{children:`Emit structured JSON instead of text`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`--help`}),`, `,_jsx(_components.code,{children:`-h`})]}),_jsxs(_components.td,{children:[`Show help for `,_jsx(_components.code,{children:`agent-help`})]})]})]})]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`entire agent-help`}),` describes the CLI installed on your machine. Use this command as the source of truth when its output differs from static documentation.`]})})]})}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":"agent-help","description":"Show agent-facing usage that matches the installed Entire CLI.","href":"/cli-reference/agent-help"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Get Help for a Command","slug":"get-help-for-a-command","depth":2,"children":[]},{"title":"Get Structured Output","slug":"get-structured-output","depth":2,"children":[]},{"title":"Flags","slug":"flags","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/entire/b963970832b99ecc/glossary-filter.js","/_mintlify/custom/entire/b6ce8e1b27407223/hubspot.js"],"subdomain":"entire","siteName":"Entire","title":"agent-help - Entire","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-12T23:34:24.063Z","originalFileLocation":"cli-reference/agent-help.mdx"},"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=\"Show agent-facing usage that matches the installed Entire CLI.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Entire\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/entire/CWWUNQDErR6A3ShO/_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/entire/CWWUNQDErR6A3ShO/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/entire/CWWUNQDErR6A3ShO/_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/entire/CWWUNQDErR6A3ShO/_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/entire/CWWUNQDErR6A3ShO/_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/entire/CWWUNQDErR6A3ShO/_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/entire/CWWUNQDErR6A3ShO/_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/entire/CWWUNQDErR6A3ShO/_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/entire/CWWUNQDErR6A3ShO/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"agent-help - Entire\">\u003cmeta data-mint-head property=\"og:description\" content=\"Show agent-facing usage that matches the installed Entire CLI.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Entire\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.entire.com/cli-reference/agent-help\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://entire.mintlify.site/_mintlify/api/og/v2?division=Commands\u0026amp;title=agent-help\u0026amp;description=Show+agent-facing+usage+that+matches+the+installed+Entire+CLI.\u0026amp;theme=7a8b70aed760754fd5070e67\u0026amp;signature=6b3468730fc483d5fd5f9bf515548acc4098e5722b28eed442100519da7d0164\">\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=\"agent-help - Entire\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Show agent-facing usage that matches the installed Entire CLI.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://entire.mintlify.site/_mintlify/api/og/v2?division=Commands\u0026amp;title=agent-help\u0026amp;description=Show+agent-facing+usage+that+matches+the+installed+Entire+CLI.\u0026amp;theme=7a8b70aed760754fd5070e67\u0026amp;signature=6b3468730fc483d5fd5f9bf515548acc4098e5722b28eed442100519da7d0164\">\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/entire/CWWUNQDErR6A3ShO/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Entire\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#372aac\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.entire.com/cli-reference/agent-help\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/cli-reference/agent-help.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.entire.com/#organization\",\"name\":\"Entire\",\"url\":\"https://docs.entire.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/entire/dU84oUx3gFbNHZ8_/logo/light.svg?fit=max\u0026auto=format\u0026n=dU84oUx3gFbNHZ8_\u0026q=85\u0026s=6ce790665b11c249fbf9d14a33f846c4\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.entire.com#website\",\"name\":\"Entire\",\"url\":\"https://docs.entire.com\",\"publisher\":{\"@id\":\"https://docs.entire.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.entire.com/cli-reference/agent-help#webpage\",\"url\":\"https://docs.entire.com/cli-reference/agent-help\",\"name\":\"agent-help\",\"description\":\"Show agent-facing usage that matches the installed Entire CLI.\",\"dateModified\":\"2026-11-12T23:34:24.063Z\",\"isPartOf\":{\"@id\":\"https://docs.entire.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.entire.com/cli-reference/agent-help#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.entire.com/cli-reference/agent-help#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Commands\",\"item\":\"https://docs.entire.com/cli-reference/activity\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"agent-help\",\"item\":\"https://docs.entire.com/cli-reference/agent-help\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.entire.com/cli-reference/agent-help#article\",\"headline\":\"agent-help\",\"name\":\"agent-help\",\"description\":\"Show agent-facing usage that matches the installed Entire CLI.\",\"url\":\"https://docs.entire.com/cli-reference/agent-help\",\"mainEntityOfPage\":{\"@id\":\"https://docs.entire.com/cli-reference/agent-help#webpage\"},\"dateModified\":\"2026-11-12T23:34:24.063Z\",\"publisher\":{\"@id\":\"https://docs.entire.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.entire.com#website\"}}]}\u003c/script>","agentPointerHref":"/cli-reference/agent-help.md","siteName":"Entire","nav":{"global":{"anchors":[{"anchor":"GitHub","icon":"github","href":"https://github.com/entireio"},{"anchor":"Discord","icon":"discord","href":"https://discord.gg/jZJs3Tue4S"},{"anchor":"Blog","icon":"newspaper","href":"https://entire.com/blog"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"Agents","pages":[{"title":"Agents","href":"/agents/overview"}]},{"tab":"CLI Reference","groups":[{"group":"Commands","pages":[{"title":"activity","href":"/cli-reference/activity"},{"title":"agent","description":"Manage agent integrations in the current repository.","href":"/cli-reference/agent"},{"title":"agent-help","href":"/cli-reference/agent-help"},{"title":"api","description":"Make an authenticated request to an Entire API and print the response.","href":"/cli-reference/api"},{"title":"auth","href":"/cli-reference/auth"},{"title":"blame","href":"/cli-reference/blame"},{"title":"checkpoint","href":"/cli-reference/checkpoint"},{"title":"clean","href":"/cli-reference/clean"},{"title":"cluster","href":"/cli-reference/cluster"},{"title":"completion","href":"/cli-reference/completion"},{"title":"configure","href":"/cli-reference/configure"},{"title":"disable","href":"/cli-reference/disable"},{"title":"dispatch","href":"/cli-reference/dispatch"},{"title":"doctor","href":"/cli-reference/doctor"},{"title":"enable","href":"/cli-reference/enable"},{"title":"experts","href":"/cli-reference/experts"},{"title":"grant","href":"/cli-reference/grant"},{"title":"entire-graph","href":"/cli-reference/graph"},{"title":"help","href":"/cli-reference/help"},{"title":"import","href":"/cli-reference/import"},{"title":"investigate","href":"/cli-reference/investigate"},{"title":"labs","href":"/cli-reference/labs"},{"title":"login","href":"/cli-reference/login"},{"title":"logout","href":"/cli-reference/logout"},{"title":"mcp","href":"/cli-reference/mcp"},{"title":"org","href":"/cli-reference/org"},{"title":"plugin","href":"/cli-reference/plugin"},{"title":"project","href":"/cli-reference/project"},{"title":"recap","href":"/cli-reference/recap"},{"title":"repo","href":"/cli-reference/repo"},{"title":"review","href":"/cli-reference/review"},{"title":"runner","href":"/cli-reference/runner"},{"title":"search","href":"/cli-reference/search"},{"title":"session","href":"/cli-reference/session"},{"title":"service-account","href":"/cli-reference/service-account"},{"title":"status","href":"/cli-reference/status"},{"title":"tokens","href":"/cli-reference/tokens"},{"title":"trail","href":"/cli-reference/trail"},{"title":"version","href":"/cli-reference/version"},{"title":"why","href":"/cli-reference/why"},{"title":"Global Flags","href":"/cli-reference/global-flags"}]}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/guides/api/getting-started"}]},{"tab":"Plugins","pages":[{"title":"Plugins","href":"/guides/api/plugins/overview"}]},{"tab":"Learn","pages":[{"title":"Learn","href":"/learn/overview"}]}]},"basePath":"","title":"agent-help - Entire","buildId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","deploymentId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","dynamics":[],"chunks":[]}