API keys are separate from subscriptions. If you use Claude Pro/Max or ChatGPT Plus, you’ll need to set up API billing separately at console.anthropic.com or platform.openai.com.
Step 1: Install CLI & Sign Up
npm install -g @orchagent/cli
Go to orchagent.io and create a free account, then authenticate:
orchagent login
Verify Setup (Optional)
orchagent doctor
This checks your environment, config, and connectivity. If everything shows green checkmarks, you’re ready to go.
Step 2: Create an Agent
Initialize a new agent project:
orch init my-agentcd my-agent
Not sure what to build? Run orch init with no arguments in your terminal to launch an interactive wizard. It walks you through choosing a use case, language, and template — no flags needed.
This creates:
orchagent.json — agent manifest (type: "prompt" by default)
prompt.md — your prompt template
schema.json — input/output schemas
Edit prompt.md with your prompt and schema.json with your input/output definitions.
Building a tool type? Use orch init my-tool --type tool to scaffold a code runtime project. Add --language javascript for JavaScript with main.js and package.json, or use --template discord-js for a JavaScript Discord bot. See CLI Commands for all options.
Using Claude Code, Cursor, or another AI coding tool? Install the agent-builder skill for the complete platform reference:
orch skill install orchagent/agent-builder
Your AI assistant will know the exact sandbox contracts, boilerplate patterns, and environment details to build any agent type.
By default, orch init creates a prompt type (prompt + schema → single LLM call). Use --type tool for code runtime or --type agent for a managed LLM loop. See CLI Commands for all options.
Step 3: Test Locally
orch run . --local --input '{"text": "test input"}'
This runs the agent on your machine using your local LLM keys.
Tip: Use @file for complex inputs. Shell special characters (!, $, backticks) can break inline JSON. Put your input in a file instead:
orch run . --local --data @input.json
This reads JSON from input.json — no escaping needed. Also supports @- for stdin.
Step 4: Publish
orch publish
Your agent is now live and runnable by your team.
Step 5: Run It
# Via CLI — inline JSONorchagent run yourorg/my-agent --data '{"text": "hello world"}'# Via CLI — JSON from file (recommended for complex inputs)orchagent run yourorg/my-agent --data @input.json# Or your team can use the web UI at orchagent.io
Try a Deployed Agent
Want to see the platform in action first? Run one of our showcase agents:
Run Locally (No Account Needed)
npx @orchagent/cli run --local orchagent/secrets-scanner https://github.com/your/repo
Run on Server
orchagent run orchagent/secrets-scanner https://github.com/your/repo
Quick Reference
Command
What It Does
Where It Runs
orch run <agent>
Execute agent
Cloud (E2B sandbox) by default
orch run --local <agent>
Download and execute agent locally
Your machine
orch install <agent>
Export agent as sub-agent for AI tools
Local files
orch skill install <skill>
Download skill files for AI tools
Local files
orch pull <agent>
Reconstruct a local project from a published agent
-
orch fork <agent>
Fork a public agent into your workspace
-
orch update
Update installed agents to latest
-
orch formats
List available export formats
-
orch schedule create
Create cron or webhook schedule
Cloud
orch schedule list
List your schedules
-
orch service deploy
Deploy agent as always-on service
Cloud (Cloud Run)
orch service list
List running services
-
When to Use What
Want AI to DO something now? |-- Need it local/private? --> orch run --local \-- Want managed infra? --> orch runWant AI to KNOW something? \-- Download knowledge --> orch skill installWant to DELEGATE to sub-agents? \-- Export for AI tools --> orch installWant to RECONSTRUCT a local project? \-- Pull published source --> orch pull
Running with Files
Many agents process files. Pass a file as an argument or use the --file flag:
# Code runtime agents: pass file as argument (uploaded to sandbox)orchagent run acme/invoice-scanner invoice.pdf# Direct LLM agents: use --file (content is read and mapped to input schema)orchagent run acme/useeffect-checker --file src/App.tsx# Pipe file to stdincat document.pdf | orchagent run acme/pdf-parser
Running with JSON
For direct LLM agents that accept JSON input:
# Inline JSONorchagent run acme/text-extractor --data '{"text":"hello world"}'# JSON from fileorchagent run acme/text-extractor --data @input.json
Next Steps
API Reference
Full endpoint documentation
CLI Commands
All CLI commands explained
Agent Types
The four types — prompt, tool, agent, skill
Code Examples
Python, JavaScript, curl examples
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"orchagent","colors":{"primary":"#f97316","light":"#fb923c","dark":"#ea580c"},"logo":{"light":"https://mintcdn.com/orchagent/lVAefPNdSpLQBxWM/logo/logo-icon-simple.png?fit=max\u0026auto=format\u0026n=lVAefPNdSpLQBxWM\u0026q=85\u0026s=f70baac508e66a7f7b04cb2aadd80407","dark":"https://mintcdn.com/orchagent/lVAefPNdSpLQBxWM/logo/logo-icon-simple.png?fit=max\u0026auto=format\u0026n=lVAefPNdSpLQBxWM\u0026q=85\u0026s=f70baac508e66a7f7b04cb2aadd80407"},"favicon":"/logo/logo-icon-simple.png","api":{},"navbar":{"links":[{"href":"https://orchagent.io/dashboard","label":"Dashboard"}],"primary":{"type":"button","label":"Sign Up","href":"https://orchagent.io"}},"footer":{"socials":{"github":"https://github.com/orchagent","x":"https://twitter.com/orchagent"}},"contextual":{"options":["copy","view","claude","chatgpt","cursor"],"display":"header"},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","href":""}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"orchagent","hasAudioNarration":false,"actualSubdomain":"orchagent","customDomains":["docs.orchagent.io"],"gitSource":{"type":"github","owner":"jp730","repo":"agents-by-orchagent","deployBranch":"main","contentDirectory":"docs-public-v2","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae945f993242cef80c30d49:success","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"en","tag":"Documentation","count":29},{"language":"en","tag":"Using Agents","count":10},{"language":"en","tag":"Building Agents","count":7},{"language":"en","tag":"Concepts","count":5},{"language":"en","tag":"Get Started","count":4},{"language":"en","tag":"Guides","count":2},{"language":"en","tag":"API Reference","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":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":"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},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"quickstart","slug":"/quickstart","pageMetadata":{"title":"Quickstart","description":"Deploy your first agent in minutes","href":"/quickstart","hidden":false},"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: \"Deploy your first agent in minutes\"\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`,hr:`hr`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{Card,CardGroup,CodeBlock,Heading,Note,Table,Tip}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Build an agent, deploy it, and run it — all from your terminal.`}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`orchagent has four types: `,_jsx(_components.strong,{children:`prompt`}),`, `,_jsx(_components.strong,{children:`tool`}),`, `,_jsx(_components.strong,{children:`agent`}),`, and `,_jsx(_components.strong,{children:`skill`}),`. The commands below work for all of them. See `,_jsx(_components.a,{href:`/building-agents/agent-types`,children:`Agent Types`}),` for the differences.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`prerequisites`,children:`Prerequisites`}),`\n`,_jsx(_components.p,{children:`Set up an LLM API key in your environment:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,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:`5`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`export`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` GEMINI_API_KEY`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"your-key\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# or`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`export`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` OPENAI_API_KEY`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"your-key\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# or`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`export`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` ANTHROPIC_API_KEY`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"your-key\"`})]}),`\n`]})})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`API keys are separate from subscriptions. If you use Claude Pro/Max or ChatGPT Plus, you’ll need to set up API billing separately at `,_jsx(_components.a,{href:`https://console.anthropic.com`,children:`console.anthropic.com`}),` or `,_jsx(_components.a,{href:`https://platform.openai.com`,children:`platform.openai.com`}),`.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`step-1-install-cli-\u0026-sign-up`,children:`Step 1: Install CLI \u0026 Sign Up`}),`\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:`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:` @orchagent/cli`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Go to `,_jsx(_components.a,{href:`https://orchagent.io`,children:`orchagent.io`}),` and create a free account, then authenticate:`]}),`\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:`orchagent`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` login`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`verify-setup-optional`,children:`Verify Setup (Optional)`}),`\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:`orchagent`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` doctor`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`This checks your environment, config, and connectivity. If everything shows green checkmarks, you’re ready to go.`}),`\n`,_jsx(Heading,{level:`2`,id:`step-2-create-an-agent`,children:`Step 2: Create an Agent`}),`\n`,_jsx(_components.p,{children:`Initialize a new agent project:`}),`\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:`orch`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` init`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` my-agent`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`cd`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` my-agent`})]}),`\n`]})})}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Not sure what to build?`}),` Run `,_jsx(_components.code,{children:`orch init`}),` with no arguments in your terminal to launch an interactive wizard. It walks you through choosing a use case, language, and template — no flags needed.`]})}),`\n`,_jsx(_components.p,{children:`This creates:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`orchagent.json`}),` — agent manifest (type: `,_jsx(_components.code,{children:`\"prompt\"`}),` by default)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`prompt.md`}),` — your prompt template`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`schema.json`}),` — input/output schemas`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`Edit `,_jsx(_components.code,{children:`prompt.md`}),` with your prompt and `,_jsx(_components.code,{children:`schema.json`}),` with your input/output definitions.`]}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Building a tool type?`}),` Use `,_jsx(_components.code,{children:`orch init my-tool --type tool`}),` to scaffold a code runtime project. Add `,_jsx(_components.code,{children:`--language javascript`}),` for JavaScript with `,_jsx(_components.code,{children:`main.js`}),` and `,_jsx(_components.code,{children:`package.json`}),`, or use `,_jsx(_components.code,{children:`--template discord-js`}),` for a JavaScript Discord bot. See `,_jsx(_components.a,{href:`/using-agents/cli-commands#init`,children:`CLI Commands`}),` for all options.`]})}),`\n`,_jsxs(Tip,{children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Using Claude Code, Cursor, or another AI coding tool?`}),` Install the agent-builder skill for the complete platform reference:`]}),_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:`orch`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` skill`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` install`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` orchagent/agent-builder`})]}),`\n`]})})}),_jsx(_components.p,{children:`Your AI assistant will know the exact sandbox contracts, boilerplate patterns, and environment details to build any agent type.`})]}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`By default, `,_jsx(_components.code,{children:`orch init`}),` creates a `,_jsx(_components.code,{children:`prompt`}),` type (prompt + schema → single LLM call). Use `,_jsx(_components.code,{children:`--type tool`}),` for code runtime or `,_jsx(_components.code,{children:`--type agent`}),` for a managed LLM loop. See `,_jsx(_components.a,{href:`/using-agents/cli-commands#init`,children:`CLI Commands`}),` for all options.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`step-3-test-locally`,children:`Step 3: Test Locally`}),`\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:`orch`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` run`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` .`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --local`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --input`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{\"text\": \"test input\"}'`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`This runs the agent on your machine using your local LLM keys.`}),`\n`,_jsxs(Tip,{children:[_jsxs(_components.p,{children:[_jsxs(_components.strong,{children:[`Tip: Use `,_jsx(_components.code,{children:`@file`}),` for complex inputs.`]}),` Shell special characters (`,_jsx(_components.code,{children:`!`}),`, `,_jsx(_components.code,{children:`$`}),`, backticks) can break inline JSON. Put your input in a file instead:`]}),_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:`orch`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` run`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` .`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --local`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` @input.json`})]}),`\n`]})})}),_jsxs(_components.p,{children:[`This reads JSON from `,_jsx(_components.code,{children:`input.json`}),` — no escaping needed. Also supports `,_jsx(_components.code,{children:`@-`}),` for stdin.`]})]}),`\n`,_jsx(Heading,{level:`2`,id:`step-4-publish`,children:`Step 4: Publish`}),`\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:`orch`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` publish`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`Your agent is now live and runnable by your team.`}),`\n`,_jsx(Heading,{level:`2`,id:`step-5-run-it`,children:`Step 5: Run It`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`7`,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:`7`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Via CLI — inline JSON`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`orchagent`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` run`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` yourorg/my-agent`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{\"text\": \"hello world\"}'`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Via CLI — JSON from file (recommended for complex inputs)`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`orchagent`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` run`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` yourorg/my-agent`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` @input.json`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Or your team can use the web UI at orchagent.io`})}),`\n`]})})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`try-a-deployed-agent`,children:`Try a Deployed Agent`}),`\n`,_jsx(_components.p,{children:`Want to see the platform in action first? Run one of our showcase agents:`}),`\n`,_jsx(Heading,{level:`3`,id:`run-locally-no-account-needed`,children:`Run Locally (No Account Needed)`}),`\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:`npx`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` @orchagent/cli`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` run`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --local`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` orchagent/secrets-scanner`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://github.com/your/repo`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`run-on-server`,children:`Run on Server`}),`\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:`orchagent`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` run`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` orchagent/secrets-scanner`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://github.com/your/repo`})]}),`\n`]})})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`quick-reference`,children:`Quick Reference`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`What It Does`}),_jsx(_components.th,{children:`Where It Runs`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`orch run \u003cagent>`})}),_jsx(_components.td,{children:`Execute agent`}),_jsx(_components.td,{children:`Cloud (E2B sandbox) by default`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`orch run --local \u003cagent>`})}),_jsx(_components.td,{children:`Download and execute agent locally`}),_jsx(_components.td,{children:`Your machine`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`orch install \u003cagent>`})}),_jsx(_components.td,{children:`Export agent as sub-agent for AI tools`}),_jsx(_components.td,{children:`Local files`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`orch skill install \u003cskill>`})}),_jsx(_components.td,{children:`Download skill files for AI tools`}),_jsx(_components.td,{children:`Local files`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`orch pull \u003cagent>`})}),_jsx(_components.td,{children:`Reconstruct a local project from a published agent`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`-`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`orch fork \u003cagent>`})}),_jsx(_components.td,{children:`Fork a public agent into your workspace`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`-`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`orch update`})}),_jsx(_components.td,{children:`Update installed agents to latest`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`-`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`orch formats`})}),_jsx(_components.td,{children:`List available export formats`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`-`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`orch schedule create`})}),_jsx(_components.td,{children:`Create cron or webhook schedule`}),_jsx(_components.td,{children:`Cloud`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`orch schedule list`})}),_jsx(_components.td,{children:`List your schedules`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`-`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`orch service deploy`})}),_jsx(_components.td,{children:`Deploy agent as always-on service`}),_jsx(_components.td,{children:`Cloud (Cloud Run)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`orch service list`})}),_jsx(_components.td,{children:`List running services`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`-`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`when-to-use-what`,children:`When to Use What`}),`\n`,_jsx(CodeBlock,{numberOfLines:`13`,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:`13`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Want AI to DO something now?`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` |-- Need it local/private? --> orch run --local`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \\\\-- Want managed infra? --> orch run`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Want AI to KNOW something?`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \\\\-- Download knowledge --> orch skill install`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Want to DELEGATE to sub-agents?`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \\\\-- Export for AI tools --> orch install`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Want to RECONSTRUCT a local project?`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \\\\-- Pull published source --> orch pull`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Heading,{level:`2`,id:`running-with-files`,children:`Running with Files`}),`\n`,_jsxs(_components.p,{children:[`Many agents process files. Pass a file as an argument or use the `,_jsx(_components.code,{children:`--file`}),` flag:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`8`,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:`8`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Code runtime agents: pass file as argument (uploaded to sandbox)`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`orchagent`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` run`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` acme/invoice-scanner`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` invoice.pdf`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Direct LLM agents: use --file (content is read and mapped to input schema)`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`orchagent`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` run`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` acme/useeffect-checker`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --file`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` src/App.tsx`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Pipe file to stdin`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cat`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` document.pdf`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` |`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:` orchagent`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` run`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` acme/pdf-parser`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`running-with-json`,children:`Running with JSON`}),`\n`,_jsx(_components.p,{children:`For direct LLM agents that accept JSON input:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,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:`5`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Inline JSON`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`orchagent`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` run`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` acme/text-extractor`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{\"text\":\"hello world\"}'`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# JSON from file`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`orchagent`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` run`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` acme/text-extractor`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` @input.json`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`next-steps`,children:`Next Steps`}),`\n`,_jsxs(CardGroup,{cols:2,children:[_jsx(Card,{title:`API Reference`,icon:`code`,href:`/using-agents/api-reference`,children:_jsx(_components.p,{children:`Full endpoint documentation`})}),_jsx(Card,{title:`CLI Commands`,icon:`terminal`,href:`/using-agents/cli-commands`,children:_jsx(_components.p,{children:`All CLI commands explained`})}),_jsx(Card,{title:`Agent Types`,icon:`hammer`,href:`/building-agents/agent-types`,children:_jsx(_components.p,{children:`The four types — prompt, tool, agent, skill`})}),_jsx(Card,{title:`Code Examples`,icon:`brackets-curly`,href:`/using-agents/code-snippets`,children:_jsx(_components.p,{children:`Python, JavaScript, curl examples`})})]})]})}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":"Deploy your first agent in minutes","href":"/quickstart","hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Prerequisites","slug":"prerequisites","depth":2,"children":[]},{"title":"Step 1: Install CLI \u0026 Sign Up","slug":"step-1-install-cli-\u0026-sign-up","depth":2,"children":[{"title":"Verify Setup (Optional)","slug":"verify-setup-optional","depth":3,"children":[]}]},{"title":"Step 2: Create an Agent","slug":"step-2-create-an-agent","depth":2,"children":[]},{"title":"Step 3: Test Locally","slug":"step-3-test-locally","depth":2,"children":[]},{"title":"Step 4: Publish","slug":"step-4-publish","depth":2,"children":[]},{"title":"Step 5: Run It","slug":"step-5-run-it","depth":2,"children":[]},{"title":"Try a Deployed Agent","slug":"try-a-deployed-agent","depth":2,"children":[{"title":"Run Locally (No Account Needed)","slug":"run-locally-no-account-needed","depth":3,"children":[]},{"title":"Run on Server","slug":"run-on-server","depth":3,"children":[]}]},{"title":"Quick Reference","slug":"quick-reference","depth":2,"children":[{"title":"When to Use What","slug":"when-to-use-what","depth":3,"children":[]}]},{"title":"Running with Files","slug":"running-with-files","depth":2,"children":[]},{"title":"Running with JSON","slug":"running-with-json","depth":2,"children":[]},{"title":"Next Steps","slug":"next-steps","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"orchagent","siteName":"orchagent","title":"Quickstart - orchagent","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/quickstart","matchLevel":0}}},"lastModified":"2026-02-26T16:58:38.534Z","originalFileLocation":"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=\"Deploy your first agent in minutes\">\u003cmeta data-mint-head name=\"application-name\" content=\"orchagent\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/orchagent/--4KFm35xJn02I7A/_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/orchagent/--4KFm35xJn02I7A/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/orchagent/--4KFm35xJn02I7A/_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/orchagent/--4KFm35xJn02I7A/_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/orchagent/--4KFm35xJn02I7A/_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/orchagent/--4KFm35xJn02I7A/_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/orchagent/--4KFm35xJn02I7A/_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/orchagent/--4KFm35xJn02I7A/_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/orchagent/--4KFm35xJn02I7A/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Quickstart - orchagent\">\u003cmeta data-mint-head property=\"og:description\" content=\"Deploy your first agent in minutes\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"orchagent\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.orchagent.io/quickstart\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://orchagent.mintlify.site/_mintlify/api/og/v2?division=Get+Started\u0026amp;title=Quickstart\u0026amp;description=Deploy+your+first+agent+in+minutes\u0026amp;theme=540c1f0e430c2ddde97fe119\u0026amp;signature=8e764ffd7231e807bacab22543d30a19b8dfee48c2749eb5bd2c13e408de2a22\">\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 - orchagent\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Deploy your first agent in minutes\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://orchagent.mintlify.site/_mintlify/api/og/v2?division=Get+Started\u0026amp;title=Quickstart\u0026amp;description=Deploy+your+first+agent+in+minutes\u0026amp;theme=540c1f0e430c2ddde97fe119\u0026amp;signature=8e764ffd7231e807bacab22543d30a19b8dfee48c2749eb5bd2c13e408de2a22\">\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/orchagent/--4KFm35xJn02I7A/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"orchagent\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#f97316\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.orchagent.io/quickstart\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/quickstart.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.orchagent.io/#organization\",\"name\":\"orchagent\",\"url\":\"https://docs.orchagent.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/orchagent/lVAefPNdSpLQBxWM/logo/logo-icon-simple.png?fit=max\u0026auto=format\u0026n=lVAefPNdSpLQBxWM\u0026q=85\u0026s=f70baac508e66a7f7b04cb2aadd80407\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.orchagent.io#website\",\"name\":\"orchagent\",\"url\":\"https://docs.orchagent.io\",\"publisher\":{\"@id\":\"https://docs.orchagent.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.orchagent.io/quickstart#webpage\",\"url\":\"https://docs.orchagent.io/quickstart\",\"name\":\"Quickstart\",\"description\":\"Deploy your first agent in minutes\",\"dateModified\":\"2026-02-26T16:58:38.534Z\",\"isPartOf\":{\"@id\":\"https://docs.orchagent.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.orchagent.io/quickstart#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.orchagent.io/quickstart#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Get Started\",\"item\":\"https://docs.orchagent.io\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Quickstart\",\"item\":\"https://docs.orchagent.io/quickstart\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.orchagent.io/quickstart#article\",\"headline\":\"Quickstart\",\"name\":\"Quickstart\",\"description\":\"Deploy your first agent in minutes\",\"url\":\"https://docs.orchagent.io/quickstart\",\"mainEntityOfPage\":{\"@id\":\"https://docs.orchagent.io/quickstart#webpage\"},\"dateModified\":\"2026-02-26T16:58:38.534Z\",\"publisher\":{\"@id\":\"https://docs.orchagent.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.orchagent.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"orchagent\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"orchagent\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/quickstart.md","siteName":"orchagent","nav":{"global":null,"languages":[{"language":"en","tabs":[{"tab":"Documentation","groups":[{"group":"Get Started","pages":[{"title":"What is orchagent?","description":"Deploy your AI agent. Your team can use it.","href":""},{"title":"Quickstart","href":"/quickstart"},{"title":"orch-hq Desktop App","description":"Your AI command centre — see what your agents are doing, talk to Claude, and manage everything from one place.","href":"/orch-hq"},{"title":"Troubleshooting","href":"/troubleshooting"}]},{"group":"Using Agents","pages":[{"title":"API Reference","href":"/using-agents/api-reference"},{"title":"CLI Commands","href":"/using-agents/cli-commands","hidden":false},{"title":"Scheduling \u0026 Webhooks","href":"/using-agents/scheduling"},{"title":"Always-On Services","href":"/using-agents/services"},{"title":"Agent Messages","href":"/using-agents/messages"},{"title":"Agent Tasks","href":"/using-agents/tasks"},{"title":"Integrations","href":"/using-agents/integrations"},{"title":"MCP Server","href":"/using-agents/mcp"},{"title":"Agent Storage","href":"/using-agents/storage"},{"title":"Code Snippets","href":"/using-agents/code-snippets"}]},{"group":"Building Agents","pages":[{"title":"Agent Types","href":"/building-agents/agent-types"},{"title":"Manifest Format","href":"/building-agents/manifest-format"},{"title":"Custom Environments","href":"/building-agents/environments"},{"title":"Publishing","href":"/building-agents/publishing"},{"title":"Orchestration","href":"/building-agents/orchestration"},{"title":"Building an Orchestrator","href":"/building-agents/building-orchestrators"},{"title":"OrchAgent SDK","href":"/building-agents/sdk"}]},{"group":"Guides","pages":[{"title":"Guide: Multi-Agent Orchestration","href":"/guides/orchestration-walkthrough"},{"title":"Guide: CI/CD Integration","href":"/guides/cicd"}]},{"group":"Concepts","pages":[{"title":"Security","href":"/concepts/security"},{"title":"Bring Your Own Key (BYOK)","href":"/concepts/byok"},{"title":"Local vs Server Execution","href":"/concepts/local-vs-server"},{"title":"Rate Limits","href":"/concepts/rate-limits"},{"title":"Billing \u0026 Credits","href":"/concepts/billing"}]},{"group":"API Reference","pages":[{"title":"API Overview","href":"/api-reference/overview"}]}]}]}]},"basePath":"","title":"Quickstart - orchagent","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":[],"chunks":[]}