[{"data":1,"prerenderedAt":835},["ShallowReactive",2],{"navigation_docs":3,"-platform-cli-reference":151,"-platform-cli-reference-surround":830},[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":92,"body":153,"description":823,"extension":824,"links":825,"meta":826,"navigation":827,"path":93,"seo":828,"stem":94,"__hash__":829},"docs/3.platform/11.cli-reference.md",{"type":154,"value":155,"toc":809},"minimark",[156,161,182,188,192,196,233,236,239,267,278,281,293,304,307,319,322,356,363,365,377,399,402,439,442,481,492,495,521,524,528,663,667,805],[157,158,160],"h2",{"id":159},"overview","Overview",[162,163,164,165,169,170,174,175,178,179,181],"p",{},"The ",[166,167,168],"strong",{},"Sulala CLI"," is the command-line interface for Agent OS. Use it when the ",[171,172,173],"code",{},"sulala"," package is installed (e.g. from the repo as ",[171,176,177],{},"bun run cli -- \u003Cargs>"," or via the built binary ",[171,180,173],{},").",[162,183,184,187],{},[166,185,186],{},"Requirements:"," Bun. The CLI and server both require Bun.",[157,189,191],{"id":190},"commands","Commands",[193,194,195],"h3",{"id":195},"version",[197,198,203],"pre",{"className":199,"code":200,"language":201,"meta":202,"style":202},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","sulala version\nsulala -v\nsulala --version\n","bash","",[171,204,205,217,225],{"__ignoreMap":202},[206,207,210,213],"span",{"class":208,"line":209},"line",1,[206,211,173],{"class":212},"sBMFI",[206,214,216],{"class":215},"sfazB"," version\n",[206,218,220,222],{"class":208,"line":219},2,[206,221,173],{"class":212},[206,223,224],{"class":215}," -v\n",[206,226,228,230],{"class":208,"line":227},3,[206,229,173],{"class":212},[206,231,232],{"class":215}," --version\n",[162,234,235],{},"Prints the Agent OS version (from package.json).",[193,237,238],{"id":238},"start",[197,240,242],{"className":199,"code":241,"language":201,"meta":202,"style":202},"sulala start           # Foreground: run the server (same as bun run dev / bun run index)\nsulala start --daemon  # Background: spawn server, write PID to ~/.agent-os/sulala.pid\n",[171,243,244,255],{"__ignoreMap":202},[206,245,246,248,251],{"class":208,"line":209},[206,247,173],{"class":212},[206,249,250],{"class":215}," start",[206,252,254],{"class":253},"sHwdD","           # Foreground: run the server (same as bun run dev / bun run index)\n",[206,256,257,259,261,264],{"class":208,"line":219},[206,258,173],{"class":212},[206,260,250],{"class":215},[206,262,263],{"class":215}," --daemon",[206,265,266],{"class":253},"  # Background: spawn server, write PID to ~/.agent-os/sulala.pid\n",[162,268,269,270,273,274,277],{},"When run with ",[171,271,272],{},"--daemon",", the server runs in the background. Use ",[171,275,276],{},"sulala stop"," to stop it.",[193,279,280],{"id":280},"stop",[197,282,284],{"className":199,"code":283,"language":201,"meta":202,"style":202},"sulala stop\n",[171,285,286],{"__ignoreMap":202},[206,287,288,290],{"class":208,"line":209},[206,289,173],{"class":212},[206,291,292],{"class":215}," stop\n",[162,294,295,296,299,300,303],{},"Reads the PID from ",[171,297,298],{},"~/.agent-os/sulala.pid"," and sends SIGTERM to that process. Use only when the server was started with ",[171,301,302],{},"sulala start --daemon",".",[193,305,306],{"id":306},"onboard",[197,308,310],{"className":199,"code":309,"language":201,"meta":202,"style":202},"sulala onboard\n",[171,311,312],{"__ignoreMap":202},[206,313,314,316],{"class":208,"line":209},[206,315,173],{"class":212},[206,317,318],{"class":215}," onboard\n",[162,320,321],{},"First-time setup:",[323,324,325,337,343,346,353],"ul",{},[326,327,328,329,332,333,336],"li",{},"Creates ",[171,330,331],{},"~/.agent-os/"," (or ",[171,334,335],{},"AGENT_OS_HOME",")",[326,338,328,339,342],{},[171,340,341],{},"config.json"," with placeholder keys (API keys, channel tokens, etc.)",[326,344,345],{},"Ensures database directory exists",[326,347,348,349,352],{},"Seeds agents from seed dir (e.g. ",[171,350,351],{},"data/agents",") if the DB is empty",[326,354,355],{},"Installs system agents and system skills from seed dirs",[162,357,358,359,362],{},"Run once after install. After that, use ",[166,360,361],{},"update"," to add new system agents/skills.",[193,364,361],{"id":361},[197,366,368],{"className":199,"code":367,"language":201,"meta":202,"style":202},"sulala update\n",[171,369,370],{"__ignoreMap":202},[206,371,372,374],{"class":208,"line":209},[206,373,173],{"class":212},[206,375,376],{"class":215}," update\n",[162,378,379,380,383,384,387,388,391,392,394,395,398],{},"Requires an existing database (run ",[171,381,382],{},"sulala onboard"," first). Loads the same DB, then installs ",[166,385,386],{},"system agents"," and ",[166,389,390],{},"system skills"," from the seed directories (e.g. ",[171,393,351],{},", ",[171,396,397],{},"data/skills","). Skips items that already exist. Use after pulling new default agents or skills from the repo.",[193,400,401],{"id":401},"run",[197,403,405],{"className":199,"code":404,"language":201,"meta":202,"style":202},"sulala run \u003Cagent_id> \u003Ctask>\n",[171,406,407],{"__ignoreMap":202},[206,408,409,411,414,418,421,425,428,430,433,436],{"class":208,"line":209},[206,410,173],{"class":212},[206,412,413],{"class":215}," run",[206,415,417],{"class":416},"sMK4o"," \u003C",[206,419,420],{"class":215},"agent_i",[206,422,424],{"class":423},"sTEyZ","d",[206,426,427],{"class":416},">",[206,429,417],{"class":416},[206,431,432],{"class":215},"tas",[206,434,435],{"class":423},"k",[206,437,438],{"class":416},">\n",[162,440,441],{},"Example:",[197,443,445],{"className":199,"code":444,"language":201,"meta":202,"style":202},"sulala run echo_agent \"What is 2+2?\"\nsulala run personal_agent \"Summarize my calendar for today\"\n",[171,446,447,465],{"__ignoreMap":202},[206,448,449,451,453,456,459,462],{"class":208,"line":209},[206,450,173],{"class":212},[206,452,413],{"class":215},[206,454,455],{"class":215}," echo_agent",[206,457,458],{"class":416}," \"",[206,460,461],{"class":215},"What is 2+2?",[206,463,464],{"class":416},"\"\n",[206,466,467,469,471,474,476,479],{"class":208,"line":219},[206,468,173],{"class":212},[206,470,413],{"class":215},[206,472,473],{"class":215}," personal_agent",[206,475,458],{"class":416},[206,477,478],{"class":215},"Summarize my calendar for today",[206,480,464],{"class":416},[162,482,483,484,487,488,491],{},"Runs the given agent with the provided task text. Uses the same database as the server when present (",[171,485,486],{},"AGENT_MEMORY_DB_PATH"," or ",[171,489,490],{},"~/.agent-os/database.db","), so dashboard agents are available. Output is printed to stdout; on error, exits with code 1.",[193,493,494],{"id":494},"help",[197,496,498],{"className":199,"code":497,"language":201,"meta":202,"style":202},"sulala help\nsulala -h\nsulala --help\n",[171,499,500,507,514],{"__ignoreMap":202},[206,501,502,504],{"class":208,"line":209},[206,503,173],{"class":212},[206,505,506],{"class":215}," help\n",[206,508,509,511],{"class":208,"line":219},[206,510,173],{"class":212},[206,512,513],{"class":215}," -h\n",[206,515,516,518],{"class":208,"line":227},[206,517,173],{"class":212},[206,519,520],{"class":215}," --help\n",[162,522,523],{},"Prints usage and command list.",[157,525,527],{"id":526},"environment-variables-cli-server","Environment variables (CLI & server)",[529,530,531,544],"table",{},[532,533,534],"thead",{},[535,536,537,541],"tr",{},[538,539,540],"th",{},"Variable",[538,542,543],{},"Description",[545,546,547,561,575,588,600,612,623,636,646],"tbody",{},[535,548,549,554],{},[550,551,552],"td",{},[171,553,335],{},[550,555,556,557,560],{},"Override home directory (default ",[171,558,559],{},"~/.agent-os","). Config, DB, agents, skills, etc. live under here.",[535,562,563,568],{},[550,564,565],{},[171,566,567],{},"AGENT_OS_AGENTS_DIR",[550,569,570,571,574],{},"Override agents directory (default ",[171,572,573],{},"~/.agent-os/agents","). Used when not using SQLite for agents.",[535,576,577,582],{},[550,578,579],{},[171,580,581],{},"AGENT_OS_SKILLS_DIR",[550,583,584,585,181],{},"Override skills directory (default ",[171,586,587],{},"~/.agent-os/skills",[535,589,590,595],{},[550,591,592],{},[171,593,594],{},"AGENT_OS_SEED_AGENTS_DIR",[550,596,597,598,181],{},"Seed directory for default agents (e.g. ",[171,599,351],{},[535,601,602,607],{},[550,603,604],{},[171,605,606],{},"AGENT_OS_SEED_SKILLS_DIR",[550,608,609,610,181],{},"Seed directory for system skills (e.g. ",[171,611,397],{},[535,613,614,618],{},[550,615,616],{},[171,617,486],{},[550,619,620,621,181],{},"SQLite database path (default ",[171,622,490],{},[535,624,625,630],{},[550,626,627],{},[171,628,629],{},"PORT",[550,631,632,633,303],{},"Server port (default 3010). Used by ",[171,634,635],{},"sulala start",[535,637,638,643],{},[550,639,640],{},[171,641,642],{},"HOST",[550,644,645],{},"Server host (default 127.0.0.1).",[535,647,648,657],{},[550,649,650,394,653,656],{},[171,651,652],{},"OPENAI_API_KEY",[171,654,655],{},"OPENROUTER_API_KEY",", etc.",[550,658,659,660,181],{},"LLM API keys (can also be set in ",[171,661,662],{},"~/.agent-os/config.json",[157,664,666],{"id":665},"examples","Examples",[197,668,670],{"className":199,"code":669,"language":201,"meta":202,"style":202},"# First-time setup\nsulala onboard\n\n# Start server in foreground\nsulala start\n\n# Start server in background\nsulala start --daemon\n\n# Stop background server\nsulala stop\n\n# Run an agent\nsulala run personal_agent \"What's the weather in Tokyo?\"\n\n# Update system agents and skills\nsulala update\n\n# Show version\nsulala version\n",[171,671,672,677,683,689,695,703,708,714,724,729,735,742,747,753,769,774,780,787,792,798],{"__ignoreMap":202},[206,673,674],{"class":208,"line":209},[206,675,676],{"class":253},"# First-time setup\n",[206,678,679,681],{"class":208,"line":219},[206,680,173],{"class":212},[206,682,318],{"class":215},[206,684,685],{"class":208,"line":227},[206,686,688],{"emptyLinePlaceholder":687},true,"\n",[206,690,692],{"class":208,"line":691},4,[206,693,694],{"class":253},"# Start server in foreground\n",[206,696,698,700],{"class":208,"line":697},5,[206,699,173],{"class":212},[206,701,702],{"class":215}," start\n",[206,704,706],{"class":208,"line":705},6,[206,707,688],{"emptyLinePlaceholder":687},[206,709,711],{"class":208,"line":710},7,[206,712,713],{"class":253},"# Start server in background\n",[206,715,717,719,721],{"class":208,"line":716},8,[206,718,173],{"class":212},[206,720,250],{"class":215},[206,722,723],{"class":215}," --daemon\n",[206,725,727],{"class":208,"line":726},9,[206,728,688],{"emptyLinePlaceholder":687},[206,730,732],{"class":208,"line":731},10,[206,733,734],{"class":253},"# Stop background server\n",[206,736,738,740],{"class":208,"line":737},11,[206,739,173],{"class":212},[206,741,292],{"class":215},[206,743,745],{"class":208,"line":744},12,[206,746,688],{"emptyLinePlaceholder":687},[206,748,750],{"class":208,"line":749},13,[206,751,752],{"class":253},"# Run an agent\n",[206,754,756,758,760,762,764,767],{"class":208,"line":755},14,[206,757,173],{"class":212},[206,759,413],{"class":215},[206,761,473],{"class":215},[206,763,458],{"class":416},[206,765,766],{"class":215},"What's the weather in Tokyo?",[206,768,464],{"class":416},[206,770,772],{"class":208,"line":771},15,[206,773,688],{"emptyLinePlaceholder":687},[206,775,777],{"class":208,"line":776},16,[206,778,779],{"class":253},"# Update system agents and skills\n",[206,781,783,785],{"class":208,"line":782},17,[206,784,173],{"class":212},[206,786,376],{"class":215},[206,788,790],{"class":208,"line":789},18,[206,791,688],{"emptyLinePlaceholder":687},[206,793,795],{"class":208,"line":794},19,[206,796,797],{"class":253},"# Show version\n",[206,799,801,803],{"class":208,"line":800},20,[206,802,173],{"class":212},[206,804,216],{"class":215},[806,807,808],"style",{},"html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}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 .sHwdD, html code.shiki .sHwdD{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#546E7A;--shiki-default-font-style:italic;--shiki-dark:#676E95;--shiki-dark-font-style:italic}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}",{"title":202,"searchDepth":219,"depth":219,"links":810},[811,812,821,822],{"id":159,"depth":219,"text":160},{"id":190,"depth":219,"text":191,"children":813},[814,815,816,817,818,819,820],{"id":195,"depth":227,"text":195},{"id":238,"depth":227,"text":238},{"id":280,"depth":227,"text":280},{"id":306,"depth":227,"text":306},{"id":361,"depth":227,"text":361},{"id":401,"depth":227,"text":401},{"id":494,"depth":227,"text":494},{"id":526,"depth":219,"text":527},{"id":665,"depth":219,"text":666},"Sulala Agent OS CLI — version, start, stop, onboard, update, and run.","md",null,{},{"icon":95},{"title":92,"description":823},"sLQ7B0ByE7lhYlKwRexvx5rLfPSpOUMSmn0HXaF6qEA",[831,833],{"title":87,"path":88,"stem":89,"description":832,"icon":90,"children":-1},"Contract that an optional skill store should follow so Agent OS can list and install skills.",{"title":97,"path":98,"stem":99,"description":834,"icon":25,"children":-1},"MCP (Model Context Protocol) servers can expose extra tools to the agent. Support depends on the Agent OS build.",1773850667751]