[{"data":1,"prerenderedAt":696},["ShallowReactive",2],{"navigation_docs":3,"-getting-started-quick-start":151,"-getting-started-quick-start-surround":693},[4,15,75,136],{"title":5,"icon":6,"path":7,"stem":8,"children":9,"page":14},"Getting Started","i-lucide-rocket","/getting-started","1.getting-started",[10],{"title":11,"path":12,"stem":13,"icon":6},"Quick Start","/getting-started/quick-start","1.getting-started/1.quick-start",false,{"title":16,"icon":17,"path":18,"stem":19,"children":20,"page":14},"Guides","i-lucide-book-open","/guides","2.guides",[21,26,31,36,41,46,51,56,61,66,71],{"title":22,"path":23,"stem":24,"icon":25},"Deployment","/guides/deployment","2.guides/1.deployment","i-lucide-server",{"title":27,"path":28,"stem":29,"icon":30},"Get Help","/guides/get-help","2.guides/10.get-help","i-lucide-message-circle",{"title":32,"path":33,"stem":34,"icon":35},"Glossary","/guides/glossary","2.guides/11.glossary","i-lucide-book-marked",{"title":37,"path":38,"stem":39,"icon":40},"Concepts","/guides/concepts","2.guides/2.concepts","i-lucide-list",{"title":42,"path":43,"stem":44,"icon":45},"Roadmap","/guides/roadmap","2.guides/3.roadmap","i-lucide-map",{"title":47,"path":48,"stem":49,"icon":50},"Contribution Guide","/guides/contribution-guide","2.guides/4.contribution-guide","i-lucide-git-pull-request",{"title":52,"path":53,"stem":54,"icon":55},"Using the Dashboard","/guides/using-the-dashboard","2.guides/5.using-the-dashboard","i-lucide-layout-dashboard",{"title":57,"path":58,"stem":59,"icon":60},"Privacy and Data","/guides/privacy-and-data","2.guides/6.privacy-and-data","i-lucide-shield",{"title":62,"path":63,"stem":64,"icon":65},"Changelog","/guides/changelog","2.guides/7.changelog","i-lucide-history",{"title":67,"path":68,"stem":69,"icon":70},"Limits and Quotas","/guides/limits-and-quotas","2.guides/8.limits-and-quotas","i-lucide-gauge",{"title":72,"path":73,"stem":74,"icon":25},"Self-Hosting","/guides/self-hosting","2.guides/9.self-hosting",{"title":76,"icon":77,"path":78,"stem":79,"children":80,"page":14},"Platform","i-lucide-layers","/platform","3.platform",[81,86,91,96,100,105,110,114,119,123,128,132],{"title":82,"path":83,"stem":84,"icon":85},"Agent OS","/platform/agent","3.platform/1.agent","i-lucide-cpu",{"title":87,"path":88,"stem":89,"icon":90},"Store API Contract (for Agent OS)","/platform/store-api","3.platform/10.store-api","i-lucide-code-2",{"title":92,"path":93,"stem":94,"icon":95},"CLI Reference","/platform/cli-reference","3.platform/11.cli-reference","i-lucide-terminal",{"title":97,"path":98,"stem":99,"icon":25},"MCP Server Integration (optional)","/platform/mcp-server-integration","3.platform/12.mcp-server-integration",{"title":101,"path":102,"stem":103,"icon":104},"Channels (Telegram, Slack, Discord, Signal, Viber)","/platform/integrations","3.platform/2.integrations","i-lucide-plug",{"title":106,"path":107,"stem":108,"icon":109},"Skills Store (optional)","/platform/store","3.platform/3.store","i-lucide-store",{"title":111,"path":112,"stem":113,"icon":17},"Skills Authoring","/platform/skills-authoring","3.platform/4.skills-authoring",{"title":115,"path":116,"stem":117,"icon":118},"Security","/platform/security","3.platform/5.security","i-lucide-shield-check",{"title":120,"path":121,"stem":122,"icon":90},"Agent API Reference","/platform/agent-api","3.platform/6.agent-api",{"title":124,"path":125,"stem":126,"icon":127},"Agent Configuration","/platform/agent-config","3.platform/7.agent-config","i-lucide-settings",{"title":129,"path":130,"stem":131,"icon":127},"Channels Configuration","/platform/integrations-config","3.platform/8.integrations-config",{"title":133,"path":134,"stem":135,"icon":127},"Store Configuration (optional)","/platform/store-config","3.platform/9.store-config",{"title":137,"icon":138,"path":139,"stem":140,"children":141,"page":14},"Troubleshooting","i-lucide-wrench","/troubleshooting","4.troubleshooting",[142,146],{"title":143,"path":144,"stem":145,"icon":138},"Common Issues","/troubleshooting/common-issues","4.troubleshooting/1.common-issues",{"title":147,"path":148,"stem":149,"icon":150},"FAQ","/troubleshooting/faq","4.troubleshooting/2.faq","i-lucide-help-circle",{"id":152,"title":11,"body":153,"description":686,"extension":687,"links":688,"meta":689,"navigation":690,"path":12,"seo":691,"stem":13,"__hash__":692},"docs/1.getting-started/1.quick-start.md",{"type":154,"value":155,"toc":677},"minimark",[156,161,170,174,208,212,217,249,254,272,283,288,302,305,327,341,345,350,389,392,417,422,474,480,484,491,539,542,546,567,587,593,597,660,673],[157,158,160],"h2",{"id":159},"goal","Goal",[162,163,164,165,169],"p",{},"Run ",[166,167,168],"strong",{},"Sulala Agent OS"," on your machine: create the config directory, seed agents and skills, start the server, and run an agent from the CLI or dashboard.",[157,171,173],{"id":172},"prerequisites","Prerequisites",[175,176,177,192],"ul",{},[178,179,180,183,184,191],"li",{},[166,181,182],{},"Bun"," 1.0 or later. Install from ",[185,186,190],"a",{"href":187,"rel":188},"https://bun.sh",[189],"nofollow","bun.sh",".",[178,193,194,195,198,199,203,204,207],{},"An ",[166,196,197],{},"LLM API key"," (OpenAI or OpenRouter). Set ",[200,201,202],"code",{},"OPENAI_API_KEY"," or ",[200,205,206],{},"OPENROUTER_API_KEY"," in the environment or via Settings after onboarding.",[157,209,211],{"id":210},"step-1-install-and-run","Step 1: Install and run",[162,213,214],{},[166,215,216],{},"From the repo (sulala package):",[218,219,224],"pre",{"className":220,"code":221,"language":222,"meta":223,"style":223},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","cd sulala\nbun install\n","bash","",[200,225,226,239],{"__ignoreMap":223},[227,228,231,235],"span",{"class":229,"line":230},"line",1,[227,232,234],{"class":233},"s2Zo4","cd",[227,236,238],{"class":237},"sfazB"," sulala\n",[227,240,242,246],{"class":229,"line":241},2,[227,243,245],{"class":244},"sBMFI","bun",[227,247,248],{"class":237}," install\n",[162,250,251],{},[166,252,253],{},"First-time setup (onboard):",[218,255,257],{"className":220,"code":256,"language":222,"meta":223,"style":223},"bun run cli onboard\n",[200,258,259],{"__ignoreMap":223},[227,260,261,263,266,269],{"class":229,"line":230},[227,262,245],{"class":244},[227,264,265],{"class":237}," run",[227,267,268],{"class":237}," cli",[227,270,271],{"class":237}," onboard\n",[162,273,274,275,278,279,282],{},"This creates ",[200,276,277],{},"~/.agent-os/",", writes ",[200,280,281],{},"config.json",", creates the database, and seeds default agents and skills.",[162,284,285],{},[166,286,287],{},"Start the server:",[218,289,291],{"className":220,"code":290,"language":222,"meta":223,"style":223},"bun run dev\n",[200,292,293],{"__ignoreMap":223},[227,294,295,297,299],{"class":229,"line":230},[227,296,245],{"class":244},[227,298,265],{"class":237},[227,300,301],{"class":237}," dev\n",[162,303,304],{},"Or from the built CLI:",[218,306,308],{"className":220,"code":307,"language":222,"meta":223,"style":223},"bun run build\n./dist/cli.js start\n",[200,309,310,319],{"__ignoreMap":223},[227,311,312,314,316],{"class":229,"line":230},[227,313,245],{"class":244},[227,315,265],{"class":237},[227,317,318],{"class":237}," build\n",[227,320,321,324],{"class":229,"line":241},[227,322,323],{"class":244},"./dist/cli.js",[227,325,326],{"class":237}," start\n",[162,328,329,330,333,334,340],{},"When the server is running, you’ll see: ",[200,331,332],{},"Agent OS server running at http://127.0.0.1:3010",". Open the dashboard at ",[166,335,336],{},[185,337,338],{"href":338,"rel":339},"http://127.0.0.1:3010",[189]," (if the dashboard is served from the same origin or configured separately).",[157,342,344],{"id":343},"step-2-run-an-agent","Step 2: Run an agent",[162,346,347],{},[166,348,349],{},"From the CLI:",[218,351,353],{"className":220,"code":352,"language":222,"meta":223,"style":223},"AGENT_OS_AGENTS_DIR=./data/agents bun run cli run echo_agent \"What is 2+2?\"\n",[200,354,355],{"__ignoreMap":223},[227,356,357,361,365,368,371,373,375,377,380,383,386],{"class":229,"line":230},[227,358,360],{"class":359},"sTEyZ","AGENT_OS_AGENTS_DIR",[227,362,364],{"class":363},"sMK4o","=",[227,366,367],{"class":237},"./data/agents",[227,369,370],{"class":244}," bun",[227,372,265],{"class":237},[227,374,268],{"class":237},[227,376,265],{"class":237},[227,378,379],{"class":237}," echo_agent",[227,381,382],{"class":363}," \"",[227,384,385],{"class":237},"What is 2+2?",[227,387,388],{"class":363},"\"\n",[162,390,391],{},"Or, after onboarding (agents are in the DB):",[218,393,395],{"className":220,"code":394,"language":222,"meta":223,"style":223},"bun run cli run personal_agent \"Hello, what can you do?\"\n",[200,396,397],{"__ignoreMap":223},[227,398,399,401,403,405,407,410,412,415],{"class":229,"line":230},[227,400,245],{"class":244},[227,402,265],{"class":237},[227,404,268],{"class":237},[227,406,265],{"class":237},[227,408,409],{"class":237}," personal_agent",[227,411,382],{"class":363},[227,413,414],{"class":237},"Hello, what can you do?",[227,416,388],{"class":363},[162,418,419],{},[166,420,421],{},"Via HTTP:",[218,423,425],{"className":220,"code":424,"language":222,"meta":223,"style":223},"curl -X POST http://127.0.0.1:3010/api/agents/run \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"agent_id\":\"echo_agent\",\"task\":\"Hello!\"}'\n",[200,426,427,444,459],{"__ignoreMap":223},[227,428,429,432,435,438,441],{"class":229,"line":230},[227,430,431],{"class":244},"curl",[227,433,434],{"class":237}," -X",[227,436,437],{"class":237}," POST",[227,439,440],{"class":237}," http://127.0.0.1:3010/api/agents/run",[227,442,443],{"class":359}," \\\n",[227,445,446,449,451,454,457],{"class":229,"line":241},[227,447,448],{"class":237},"  -H",[227,450,382],{"class":363},[227,452,453],{"class":237},"Content-Type: application/json",[227,455,456],{"class":363},"\"",[227,458,443],{"class":359},[227,460,462,465,468,471],{"class":229,"line":461},3,[227,463,464],{"class":237},"  -d",[227,466,467],{"class":363}," '",[227,469,470],{"class":237},"{\"agent_id\":\"echo_agent\",\"task\":\"Hello!\"}",[227,472,473],{"class":363},"'\n",[162,475,476,479],{},[166,477,478],{},"From the dashboard:"," Open the Agents page, pick an agent, and use the chat or run form.",[157,481,483],{"id":482},"step-3-optional-install-more-skills","Step 3: (Optional) Install more skills",[162,485,486,487,490],{},"Skills live under ",[200,488,489],{},"~/.agent-os/skills/",". You can:",[175,492,493,502,515],{},[178,494,495,498,499,191],{},[166,496,497],{},"Install system skills"," — From the dashboard: Settings or Skills → Install system skills. Or call ",[200,500,501],{},"POST /api/skills/install-system",[178,503,504,507,508,511,512,191],{},[166,505,506],{},"Install from a store"," — If you use a skills store (registry URL in Settings), use the dashboard to browse and install by slug, or ",[200,509,510],{},"POST /api/skills/install"," with ",[200,513,514],{},"{ \"slug\": \"weather\" }",[178,516,517,520,521,524,525,511,528,531,532,535,536,191],{},[166,518,519],{},"Upload a skill"," — ",[200,522,523],{},"POST /api/skills/upload"," with a zip, or add a folder manually under ",[200,526,527],{},"~/.agent-os/skills/\u003Cname>/",[200,529,530],{},"skill.yaml"," (or ",[200,533,534],{},"SKILL.md",") and optional ",[200,537,538],{},"tools.yaml",[162,540,541],{},"After adding skills, assign them to agents in the Agents page (edit agent → skills).",[157,543,545],{"id":544},"step-4-optional-configure-channels","Step 4: (Optional) Configure channels",[162,547,548,549,552,553,552,556,552,559,562,563,566],{},"To talk to agents from ",[166,550,551],{},"Telegram",", ",[166,554,555],{},"Slack",[166,557,558],{},"Discord",[166,560,561],{},"Signal",", or ",[166,564,565],{},"Viber",":",[568,569,570,573,580],"ol",{},[178,571,572],{},"Create a bot or app on the platform and get the token/credentials.",[178,574,575,576,579],{},"In the dashboard go to ",[166,577,578],{},"Settings → Channels"," and configure the channel (token, signing secret if needed, default agent).",[178,581,582,583,586],{},"Expose your server over HTTPS (e.g. ngrok) and set the webhook URL for that channel. Use the ",[166,584,585],{},"set-webhook"," endpoint for Telegram/Viber if available.",[162,588,589,590,592],{},"See ",[185,591,82],{"href":83}," and channel-specific docs (e.g. TELEGRAM_SETUP.md in the repo) for details.",[157,594,596],{"id":595},"summary","Summary",[598,599,600,613],"table",{},[601,602,603],"thead",{},[604,605,606,610],"tr",{},[607,608,609],"th",{},"Step",[607,611,612],{},"What you did",[614,615,616,632,644,652],"tbody",{},[604,617,618,622],{},[619,620,621],"td",{},"1",[619,623,624,625,628,629],{},"Installed deps, ran ",[200,626,627],{},"sulala onboard",", started the server at ",[185,630,338],{"href":338,"rel":631},[189],[604,633,634,637],{},[619,635,636],{},"2",[619,638,639,640,643],{},"Ran an agent via CLI or ",[200,641,642],{},"POST /api/agents/run"," or dashboard",[604,645,646,649],{},[619,647,648],{},"3",[619,650,651],{},"(Optional) Installed skills and attached them to agents",[604,653,654,657],{},[619,655,656],{},"4",[619,658,659],{},"(Optional) Configured a messaging channel and webhook",[162,661,662,663,552,665,668,669,672],{},"Next: read ",[185,664,82],{"href":83},[185,666,667],{"href":93},"CLI reference",", and ",[185,670,671],{"href":112},"Skills authoring"," for details.",[674,675,676],"style",{},"html pre.shiki code .s2Zo4, html code.shiki .s2Zo4{--shiki-light:#6182B8;--shiki-default:#82AAFF;--shiki-dark:#82AAFF}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}",{"title":223,"searchDepth":241,"depth":241,"links":678},[679,680,681,682,683,684,685],{"id":159,"depth":241,"text":160},{"id":172,"depth":241,"text":173},{"id":210,"depth":241,"text":211},{"id":343,"depth":241,"text":344},{"id":482,"depth":241,"text":483},{"id":544,"depth":241,"text":545},{"id":595,"depth":241,"text":596},"Get Sulala Agent OS running in under 10 minutes — install with Bun, onboard, start the server, and run an agent.","md",null,{},{"icon":6},{"title":11,"description":686},"oPGqBBBbhuF6yrBugNQNFftFIOPh7p6NEZAMuOfuAzs",[688,694],{"title":22,"path":23,"stem":24,"description":695,"icon":25,"children":-1},"How to run Sulala Agent OS in production — daemon, env, and optional reverse proxy.",1773850667751]