[{"data":1,"prerenderedAt":246},["ShallowReactive",2],{"docs-\u002Fdocs\u002Fv2":3},{"id":4,"title":5,"body":6,"description":238,"extension":239,"meta":240,"navigation":241,"path":242,"seo":243,"stem":244,"__hash__":245},"docs\u002Fdocs\u002Fv2\u002Findex.md","What is Axon?",{"type":7,"value":8,"toc":232},"minimark",[9,13,17,20,25,28,89,92,96,99,127,141,149,153,158,161,176,180,183,187,191,203,210,213,216,228],[10,11,5],"h1",{"id":12},"what-is-axon",[14,15,16],"p",{},"Axon is a runtime and toolkit for AI agents. It gives you a consistent way to define an\nagent, give it capabilities, keep its sessions, and run it locally or in the cloud.",[14,18,19],{},"You write the behaviour that is unique to your agent. Axon handles the runtime around it:\ncontext, tool calls, retries, sessions, and policy.",[21,22,24],"h2",{"id":23},"a-runtime-without-the-plumbing","A runtime, without the plumbing",[14,26,27],{},"Define what an agent knows, what it can do, and what it is allowed to access. Axon then\nassembles the context, runs the loop, dispatches tools, persists sessions, and enforces the\npolicy you set. The application boundary is a single call:",[29,30,35],"pre",{"className":31,"code":32,"language":33,"meta":34,"style":34},"language-ts shiki shiki-themes dark-plus","const { stream } = axon.stream({ prompt: [session, task] })\n","ts","",[36,37,38],"code",{"__ignoreMap":34},[39,40,43,47,51,55,58,62,65,68,71,74,77,80,83,86],"span",{"class":41,"line":42},"line",1,[39,44,46],{"class":45},"scz_3","const",[39,48,50],{"class":49},"sTNBD"," { ",[39,52,54],{"class":53},"s9McN","stream",[39,56,57],{"class":49}," } = ",[39,59,61],{"class":60},"s3F5K","axon",[39,63,64],{"class":49},".",[39,66,54],{"class":67},"sCudf",[39,69,70],{"class":49},"({ ",[39,72,73],{"class":60},"prompt:",[39,75,76],{"class":49}," [",[39,78,79],{"class":60},"session",[39,81,82],{"class":49},", ",[39,84,85],{"class":60},"task",[39,87,88],{"class":49},"] })\n",[14,90,91],{},"You receive a stream of entries and decide what your application does with them. The\nruntime concerns stay in one maintained system instead of being rebuilt for every agent.",[21,93,95],{"id":94},"add-capabilities-as-modules","Add capabilities as modules",[14,97,98],{},"Integrations such as GitHub, Linear, Discord, and Stripe are modules. Install one and it\nbrings its typed tools, client setup, event handling, and any required verification with it.",[29,100,104],{"className":101,"code":102,"language":103,"meta":34,"style":34},"language-bash shiki shiki-themes dark-plus","axon install @axon\u002Fgithub\naxon install @axon\u002Flinear\n","bash",[36,105,106,117],{"__ignoreMap":34},[39,107,108,110,114],{"class":41,"line":42},[39,109,61],{"class":67},[39,111,113],{"class":112},"sKc5r"," install",[39,115,116],{"class":112}," @axon\u002Fgithub\n",[39,118,120,122,124],{"class":41,"line":119},2,[39,121,61],{"class":67},[39,123,113],{"class":112},[39,125,126],{"class":112}," @axon\u002Flinear\n",[14,128,129,130,82,133,136,137,140],{},"Your agent can then use documented calls such as ",[36,131,132],{},"github.openPr",[36,134,135],{},"github.getPrDiff",", and\n",[36,138,139],{},"linear.createIssue",". The integration is installed; it is not another subsystem for you to\nmaintain.",[14,142,143,144,64],{},"Browse the available modules in the ",[145,146,148],"a",{"href":147},"\u002Fdocs\u002Fagents","registry",[21,150,152],{"id":151},"work-with-the-agent","Work with the agent",[154,155],"terminal-image",{"alt":156,"src":157},"Axon TUI clean landing screen showing the Axon braille logo, connected agent name, model, thread ID, and registered tool count","\u002Ftui\u002Faxontuiemptychatwindowcleanlanding.webp",[14,159,160],{},"The terminal interface is where you run and inspect an agent. Tool calls are visible,\nand sessions are navigable without leaving the conversation.",[14,162,163,164,167,168,171,172,175],{},"Commands stay close to hand: ",[36,165,166],{},"^"," opens sessions, ",[36,169,170],{},"*"," changes model, and ",[36,173,174],{},">"," loads a\nprompt into the input.",[154,177],{"alt":178,"src":179},"TUI with the script palette open, showing available scripts from the active agent","\u002Ftui\u002Faxontuiwithscriptspaletteopen.webp",[14,181,182],{},"It can also manage Ollama. Browse compatible local models, start a download, and switch\nbetween local and cloud inference without changing the agent.",[154,184],{"alt":185,"src":186},"TUI model palette on the local tab showing an Ollama model downloading with progress indicator","\u002Ftui\u002Faxonmodelpaletteopenshowingdownloadinglocalmodel.webp",[21,188,190],{"id":189},"deploy-when-it-is-ready","Deploy when it is ready",[29,192,194],{"className":101,"code":193,"language":103,"meta":34,"style":34},"axon deploy\n",[36,195,196],{"__ignoreMap":34},[39,197,198,200],{"class":41,"line":42},[39,199,61],{"class":67},[39,201,202],{"class":112}," deploy\n",[14,204,205,206,209],{},"Axon deploys the same project with a public URL, API key, and durable cloud storage. When\nyou need your own infrastructure, ",[36,207,208],{},"axon build"," produces a Docker image for any container\nplatform.",[211,212],"hr",{},[14,214,215],{},"An Axon agent is a project folder: its configuration, modules, and source travel together.\nIt is not tied to a model vendor or a hosting provider.",[14,217,218,219,223,224,64],{},"Start with ",[145,220,222],{"href":221},"\u002Fdocs\u002Fv2\u002Fgetting-started\u002Finstallation","Installation",", then build ",[145,225,227],{"href":226},"\u002Fdocs\u002Fv2\u002Fgetting-started\u002Ffirst-agent","your first\nagent",[229,230,231],"style",{},"html pre.shiki code .scz_3, html code.shiki .scz_3{--shiki-default:#569CD6}html pre.shiki code .sTNBD, html code.shiki .sTNBD{--shiki-default:#D4D4D4}html pre.shiki code .s9McN, html code.shiki .s9McN{--shiki-default:#4FC1FF}html pre.shiki code .s3F5K, html code.shiki .s3F5K{--shiki-default:#9CDCFE}html pre.shiki code .sCudf, html code.shiki .sCudf{--shiki-default:#DCDCAA}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 pre.shiki code .sKc5r, html code.shiki .sKc5r{--shiki-default:#CE9178}",{"title":34,"searchDepth":119,"depth":119,"links":233},[234,235,236,237],{"id":23,"depth":119,"text":24},{"id":94,"depth":119,"text":95},{"id":151,"depth":119,"text":152},{"id":189,"depth":119,"text":190},"A runtime and toolkit for building, running, and deploying reliable AI agents.","md",{},true,"\u002Fdocs\u002Fv2",{"title":5,"description":238},"docs\u002Fv2\u002Findex","HvFfG-UCTtQqZDur7qtUR63D9_Wioe88PEeoMic2Rr4",1786630612213]