[{"data":1,"prerenderedAt":736},["ShallowReactive",2],{"docs-\u002Fdocs\u002Fv2\u002Freference\u002Fcli":3},{"id":4,"title":5,"body":6,"description":27,"extension":729,"meta":730,"navigation":731,"path":732,"seo":733,"stem":734,"__hash__":735},"docs\u002Fdocs\u002Fv2\u002Freference\u002Fcli.md","CLI Reference",{"type":7,"value":8,"toc":717},"minimark",[9,13,17,21,39,43,46,59,63,66,89,104,108,111,123,130,157,161,168,186,211,215,221,288,305,309,312,369,375,412,416,419,453,457,489,493,496,556,560,604,663,669,673,683,695,710,713],[10,11,5],"h1",{"id":12},"cli-reference",[14,15,16],"h2",{"id":16},"axon",[18,19,20],"p",{},"Open the TUI with the default agent.",[22,23,28],"pre",{"className":24,"code":25,"language":26,"meta":27,"style":27},"language-bash shiki shiki-themes dark-plus","axon\n","bash","",[29,30,31],"code",{"__ignoreMap":27},[32,33,36],"span",{"class":34,"line":35},"line",1,[32,37,25],{"class":38},"sCudf",[14,40,42],{"id":41},"axon-version","axon --version",[18,44,45],{},"Print the installed Axon version.",[22,47,49],{"className":24,"code":48,"language":26,"meta":27,"style":27},"axon --version\n",[29,50,51],{"__ignoreMap":27},[32,52,53,55],{"class":34,"line":35},[32,54,16],{"class":38},[32,56,58],{"class":57},"scz_3"," --version\n",[14,60,62],{"id":61},"axon-agent","axon --agent",[18,64,65],{},"Open a named agent instead of the default:",[22,67,69],{"className":24,"code":68,"language":26,"meta":27,"style":27},"axon --agent \u003Cname>\n",[29,70,71],{"__ignoreMap":27},[32,72,73,75,78,82,86],{"class":34,"line":35},[32,74,16],{"class":38},[32,76,77],{"class":57}," --agent",[32,79,81],{"class":80},"sTNBD"," \u003C",[32,83,85],{"class":84},"sKc5r","nam",[32,87,88],{"class":80},"e>\n",[18,90,91,92,95,96,99,100,103],{},"Regenerates ",[29,93,94],{},"axon.manifest.json",", ",[29,97,98],{},"axon.d.ts",", and ",[29,101,102],{},".axon\u002Ftools.d.ts"," before opening.",[14,105,107],{"id":106},"axon-login","axon login",[18,109,110],{},"Authenticate with your Axon account. Required before deploying or publishing.",[22,112,114],{"className":24,"code":113,"language":26,"meta":27,"style":27},"axon login\n",[29,115,116],{"__ignoreMap":27},[32,117,118,120],{"class":34,"line":35},[32,119,16],{"class":38},[32,121,122],{"class":84}," login\n",[18,124,125,126,129],{},"Opens a browser to complete authentication. Stores credentials in ",[29,127,128],{},"~\u002F.axon\u002Fauth.json",". Run once — subsequent commands use the stored session.",[22,131,133],{"className":24,"code":132,"language":26,"meta":27,"style":27},"axon logout     # clear stored credentials\naxon whoami     # print the currently authenticated account\n",[29,134,135,146],{"__ignoreMap":27},[32,136,137,139,142],{"class":34,"line":35},[32,138,16],{"class":38},[32,140,141],{"class":84}," logout",[32,143,145],{"class":144},"sOLPB","     # clear stored credentials\n",[32,147,149,151,154],{"class":34,"line":148},2,[32,150,16],{"class":38},[32,152,153],{"class":84}," whoami",[32,155,156],{"class":144},"     # print the currently authenticated account\n",[14,158,160],{"id":159},"axon-init","axon init",[18,162,163,164,167],{},"Scaffold a new named agent at ",[29,165,166],{},"~\u002F.axon\u002Fagents\u002F\u003Cname>\u002F",".",[22,169,171],{"className":24,"code":170,"language":26,"meta":27,"style":27},"axon init \u003Cname>\n",[29,172,173],{"__ignoreMap":27},[32,174,175,177,180,182,184],{"class":34,"line":35},[32,176,16],{"class":38},[32,178,179],{"class":84}," init",[32,181,81],{"class":80},[32,183,85],{"class":84},[32,185,88],{"class":80},[18,187,188,189,95,192,95,195,197,198,95,201,99,204,207,208,167],{},"Creates the agent folder with ",[29,190,191],{},"axon.config.ts",[29,193,194],{},"tsconfig.json",[29,196,98],{},", and empty ",[29,199,200],{},"prompts\u002F",[29,202,203],{},"scripts\u002F",[29,205,206],{},"server\u002F"," directories. Open it with ",[29,209,210],{},"axon --agent \u003Cname>",[14,212,214],{"id":213},"cloud-deployments","Cloud deployments",[18,216,217,218,167],{},"Agents are the only deployable Axon artifact. Deployment management therefore\nlives at the CLI root, alongside ",[29,219,220],{},"axon deploy",[22,222,224],{"className":24,"code":223,"language":26,"meta":27,"style":27},"axon deploy                     # publish and replace the current agent revision\naxon ps                         # list cloud deployments\naxon status [agent]             # inspect a deployment\naxon logs [agent] --follow      # read or follow deployment logs\naxon undeploy [agent] --yes     # tear down a deployment\n",[29,225,226,236,246,260,274],{"__ignoreMap":27},[32,227,228,230,233],{"class":34,"line":35},[32,229,16],{"class":38},[32,231,232],{"class":84}," deploy",[32,234,235],{"class":144},"                     # publish and replace the current agent revision\n",[32,237,238,240,243],{"class":34,"line":148},[32,239,16],{"class":38},[32,241,242],{"class":84}," ps",[32,244,245],{"class":144},"                         # list cloud deployments\n",[32,247,249,251,254,257],{"class":34,"line":248},3,[32,250,16],{"class":38},[32,252,253],{"class":84}," status",[32,255,256],{"class":80}," [agent]             ",[32,258,259],{"class":144},"# inspect a deployment\n",[32,261,263,265,268,271],{"class":34,"line":262},4,[32,264,16],{"class":38},[32,266,267],{"class":84}," logs",[32,269,270],{"class":80}," [agent] --follow      ",[32,272,273],{"class":144},"# read or follow deployment logs\n",[32,275,277,279,282,285],{"class":34,"line":276},5,[32,278,16],{"class":38},[32,280,281],{"class":84}," undeploy",[32,283,284],{"class":80}," [agent] --yes     ",[32,286,287],{"class":144},"# tear down a deployment\n",[18,289,290,291,95,294,99,297,300,301,304],{},"When the target is omitted, ",[29,292,293],{},"status",[29,295,296],{},"logs",[29,298,299],{},"undeploy"," use the agent\nproject in the current directory. Environment values come from that project's\n",[29,302,303],{},".env"," when deploying; there is no mutable remote environment command.",[14,306,308],{"id":307},"axon-install-axon-uninstall","axon install \u002F axon uninstall",[18,310,311],{},"Install or remove a module from an agent.",[22,313,315],{"className":24,"code":314,"language":26,"meta":27,"style":27},"axon install \u003Cid>                  # install into the agent at the current directory\naxon i \u003Cid>                        # shorthand — identical\naxon uninstall \u003Cid>                # remove an installed module\n",[29,316,317,335,352],{"__ignoreMap":27},[32,318,319,321,324,326,329,332],{"class":34,"line":35},[32,320,16],{"class":38},[32,322,323],{"class":84}," install",[32,325,81],{"class":80},[32,327,328],{"class":84},"i",[32,330,331],{"class":80},"d>                  ",[32,333,334],{"class":144},"# install into the agent at the current directory\n",[32,336,337,339,342,344,346,349],{"class":34,"line":148},[32,338,16],{"class":38},[32,340,341],{"class":84}," i",[32,343,81],{"class":80},[32,345,328],{"class":84},[32,347,348],{"class":80},"d>                        ",[32,350,351],{"class":144},"# shorthand — identical\n",[32,353,354,356,359,361,363,366],{"class":34,"line":248},[32,355,16],{"class":38},[32,357,358],{"class":84}," uninstall",[32,360,81],{"class":80},[32,362,328],{"class":84},[32,364,365],{"class":80},"d>                ",[32,367,368],{"class":144},"# remove an installed module\n",[18,370,371],{},[372,373,374],"strong",{},"Notes",[376,377,378,393,400,403],"ul",{},[379,380,381,384,385,388,389,392],"li",{},[29,382,383],{},"\u003Cid>"," is the registry identifier, always scoped: ",[29,386,387],{},"@scope\u002Fname",". The registry\nnamespace is scoped, so a bare ",[29,390,391],{},"name"," matches nothing.",[379,394,395,396,399],{},"The target is the agent project resolved from the working directory. There is no\nflag to install into a different agent — ",[29,397,398],{},"cd"," to it.",[379,401,402],{},"Installing merges the module's prompts, scripts, and tool dependencies into the agent folder. Nested module dependencies are resolved and merged automatically.",[379,404,405,406,409,410,167],{},"If the module declares ",[29,407,408],{},"needs",", the CLI prompts for env values and writes them to ",[29,411,303],{},[14,413,415],{"id":414},"axon-module","axon module",[18,417,418],{},"Create module projects. Publishing is project-dispatched at the root of the CLI.",[22,420,422],{"className":24,"code":421,"language":26,"meta":27,"style":27},"axon module init \u003Cname>            # scaffold a new module project in the current directory\naxon publish                        # publish the module project in the current directory\n",[29,423,424,443],{"__ignoreMap":27},[32,425,426,428,431,433,435,437,440],{"class":34,"line":35},[32,427,16],{"class":38},[32,429,430],{"class":84}," module",[32,432,179],{"class":84},[32,434,81],{"class":80},[32,436,85],{"class":84},[32,438,439],{"class":80},"e>            ",[32,441,442],{"class":144},"# scaffold a new module project in the current directory\n",[32,444,445,447,450],{"class":34,"line":148},[32,446,16],{"class":38},[32,448,449],{"class":84}," publish",[32,451,452],{"class":144},"                        # publish the module project in the current directory\n",[18,454,455],{},[372,456,374],{},[376,458,459,474,480],{},[379,460,461,464,465,468,469,95,471,473],{},[29,462,463],{},"axon module init"," creates ",[29,466,467],{},"module.config.ts"," and empty ",[29,470,200],{},[29,472,203],{}," directories.",[379,475,476,479],{},[29,477,478],{},"axon publish"," detects the module project from cwd and publishes it to the registry.",[379,481,482,483,488],{},"See ",[484,485,487],"a",{"href":486},"\u002Fdocs\u002Fv2\u002Fmodules\u002Fpublishing","Publishing a module"," for what is included and excluded from the bundle.",[14,490,492],{"id":491},"axon-run","axon run",[18,494,495],{},"One execution: an agent, an instruction, go.",[22,497,499],{"className":24,"code":498,"language":26,"meta":27,"style":27},"axon run -a \u003Cagent> -p \u003Cprompt>              # a prompt the agent declares\naxon run -a \u003Cagent> --text \"\u003Cinstruction>\"   # a literal instruction\n",[29,500,501,533],{"__ignoreMap":27},[32,502,503,505,508,511,513,516,519,522,524,527,530],{"class":34,"line":35},[32,504,16],{"class":38},[32,506,507],{"class":84}," run",[32,509,510],{"class":57}," -a",[32,512,81],{"class":80},[32,514,515],{"class":84},"agen",[32,517,518],{"class":80},"t> ",[32,520,521],{"class":57},"-p",[32,523,81],{"class":80},[32,525,526],{"class":84},"promp",[32,528,529],{"class":80},"t>              ",[32,531,532],{"class":144},"# a prompt the agent declares\n",[32,534,535,537,539,541,543,545,547,550,553],{"class":34,"line":148},[32,536,16],{"class":38},[32,538,507],{"class":84},[32,540,510],{"class":57},[32,542,81],{"class":80},[32,544,515],{"class":84},[32,546,518],{"class":80},[32,548,549],{"class":57},"--text",[32,551,552],{"class":84}," \"\u003Cinstruction>\"",[32,554,555],{"class":144},"   # a literal instruction\n",[18,557,558],{},[372,559,374],{},[376,561,562,568,588,595,601],{},[379,563,564,567],{},[29,565,566],{},"-a"," takes a path or a bare name under your active profile. Omitting it falls back to the working directory.",[379,569,570,572,573,577,578,581,582,572,584,587],{},[29,571,521],{}," is a ",[574,575,576],"em",{},"reference"," — resolved, and rendered when it is a ",[29,579,580],{},".vue",". ",[29,583,549],{},[574,585,586],{},"literal",", used verbatim. Passing both is an error.",[379,589,590,591,594],{},"Any other flag becomes a prompt argument, available via ",[29,592,593],{},"defineProps\u003C{}>()"," in a rendered prompt.",[379,596,597,600],{},[29,598,599],{},"--job \u003Cdir>"," tags the run with the job it belongs to. Correlation only — it changes nothing about what runs.",[379,602,603],{},"Boots the agent, runs to completion, then exits. No TUI is opened.",[22,605,607],{"className":24,"code":606,"language":26,"meta":27,"style":27},"axon run -a barry.mk3 -p scout\naxon run -a barry.mk3 -p learn --domain tracing\naxon run -a barry.mk3 --text \"Audit the org boundary.\"\n",[29,608,609,626,647],{"__ignoreMap":27},[32,610,611,613,615,617,620,623],{"class":34,"line":35},[32,612,16],{"class":38},[32,614,507],{"class":84},[32,616,510],{"class":57},[32,618,619],{"class":84}," barry.mk3",[32,621,622],{"class":57}," -p",[32,624,625],{"class":84}," scout\n",[32,627,628,630,632,634,636,638,641,644],{"class":34,"line":148},[32,629,16],{"class":38},[32,631,507],{"class":84},[32,633,510],{"class":57},[32,635,619],{"class":84},[32,637,622],{"class":57},[32,639,640],{"class":84}," learn",[32,642,643],{"class":57}," --domain",[32,645,646],{"class":84}," tracing\n",[32,648,649,651,653,655,657,660],{"class":34,"line":248},[32,650,16],{"class":38},[32,652,507],{"class":84},[32,654,510],{"class":57},[32,656,619],{"class":84},[32,658,659],{"class":57}," --text",[32,661,662],{"class":84}," \"Audit the org boundary.\"\n",[18,664,482,665,668],{},[484,666,492],{"href":667},"\u002Fdocs\u002Fv2\u002Fcli\u002Frun"," for the full reference.",[14,670,672],{"id":671},"axon-prepare","axon prepare",[18,674,675,676,95,678,99,680,682],{},"Regenerate ",[29,677,94],{},[29,679,98],{},[29,681,102],{}," for the current agent.",[22,684,686],{"className":24,"code":685,"language":26,"meta":27,"style":27},"axon prepare\n",[29,687,688],{"__ignoreMap":27},[32,689,690,692],{"class":34,"line":35},[32,691,16],{"class":38},[32,693,694],{"class":84}," prepare\n",[18,696,697,699,700,702,703,705,706,709],{},[29,698,94],{}," is the agent's module manifest. ",[29,701,98],{}," declares the auto-injected globals. ",[29,704,102],{}," contains tool type declarations for all installed modules — what makes ",[29,707,708],{},"axon.tools.*"," calls fully typed.",[18,711,712],{},"Run this after installing or removing modules if you want updated types without reopening Axon. Runs automatically on open — explicit use is only needed for mid-session type refreshes.",[714,715,716],"style",{},"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 .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 .sKc5r, html code.shiki .sKc5r{--shiki-default:#CE9178}html pre.shiki code .sOLPB, html code.shiki .sOLPB{--shiki-default:#6A9955}",{"title":27,"searchDepth":148,"depth":148,"links":718},[719,720,721,722,723,724,725,726,727,728],{"id":16,"depth":148,"text":16},{"id":41,"depth":148,"text":42},{"id":61,"depth":148,"text":62},{"id":106,"depth":148,"text":107},{"id":159,"depth":148,"text":160},{"id":213,"depth":148,"text":214},{"id":307,"depth":148,"text":308},{"id":414,"depth":148,"text":415},{"id":491,"depth":148,"text":492},{"id":671,"depth":148,"text":672},"md",{},true,"\u002Fdocs\u002Fv2\u002Freference\u002Fcli",{"title":5,"description":27},"docs\u002Fv2\u002Freference\u002Fcli","qmI2KV1XFAp6emb9JKlVMnO5jN7m9UN2o7M-pjYNci0",1785671807825]