[{"data":1,"prerenderedAt":816},["ShallowReactive",2],{"navigation":3,"\u002Freference\u002Foperator-cli":194,"\u002Freference\u002Foperator-cli-surround":811},[4,18,31,64,81,102,111,132,149],{"title":5,"path":6,"stem":7,"children":8,"page":17},"Getting started","\u002Fgetting-started","1.getting-started",[9,13],{"title":10,"path":11,"stem":12},"Introduction","\u002Fgetting-started\u002Fintroduction","1.getting-started\u002F1.introduction",{"title":14,"path":15,"stem":16},"Run your first workflow","\u002Fgetting-started\u002Fquickstart","1.getting-started\u002F2.quickstart",false,{"title":19,"path":20,"stem":21,"children":22,"page":17},"Core concepts","\u002Fconcepts","2.concepts",[23,27],{"title":24,"path":25,"stem":26},"The platform model","\u002Fconcepts\u002Fplatform","2.concepts\u002F1.platform",{"title":28,"path":29,"stem":30},"Architecture and boundaries","\u002Fconcepts\u002Farchitecture","2.concepts\u002F2.architecture",{"title":32,"path":33,"stem":34,"children":35,"page":17},"Installation","\u002Finstallation","3.installation",[36,40,44,48,52,56,60],{"title":37,"path":38,"stem":39},"Overview and requirements","\u002Finstallation\u002Foverview","3.installation\u002F1.overview",{"title":41,"path":42,"stem":43},"Local evaluation","\u002Finstallation\u002Flocal-evaluation","3.installation\u002F2.local-evaluation",{"title":45,"path":46,"stem":47},"Install the server","\u002Finstallation\u002Fserver","3.installation\u002F3.server",{"title":49,"path":50,"stem":51},"Install a runner","\u002Finstallation\u002Frunner","3.installation\u002F4.runner",{"title":53,"path":54,"stem":55},"Verify the installation","\u002Finstallation\u002Fverification","3.installation\u002F5.verification",{"title":57,"path":58,"stem":59},"Upgrade the platform","\u002Finstallation\u002Fupgrades","3.installation\u002F6.upgrades",{"title":61,"path":62,"stem":63},"Guided installer","\u002Finstallation\u002Finstaller","3.installation\u002F7.installer",{"title":65,"path":66,"stem":67,"children":68,"page":17},"Build workflows","\u002Fworkflows","4.workflows",[69,73,77],{"title":70,"path":71,"stem":72},"Build a Definition","\u002Fworkflows\u002Fdefinitions","4.workflows\u002F0.definitions",{"title":74,"path":75,"stem":76},"Deploy and run workflows","\u002Fworkflows\u002Fruns","4.workflows\u002F1.runs",{"title":78,"path":79,"stem":80},"Inputs, context, and secrets","\u002Fworkflows\u002Finputs-and-secrets","4.workflows\u002F2.inputs-and-secrets",{"title":82,"path":83,"stem":84,"children":85,"page":17},"Run and recover","\u002Foperations","5.operations",[86,90,94,98],{"title":87,"path":88,"stem":89},"Monitor Runs","\u002Foperations\u002Fmonitoring","5.operations\u002F1.monitoring",{"title":91,"path":92,"stem":93},"Approve prepared steps","\u002Foperations\u002Fapprovals","5.operations\u002F2.approvals",{"title":95,"path":96,"stem":97},"Recover or cancel execution","\u002Foperations\u002Frecovery","5.operations\u002F3.recovery",{"title":99,"path":100,"stem":101},"Troubleshooting","\u002Foperations\u002Ftroubleshooting","5.operations\u002F4.troubleshooting",{"title":103,"path":104,"stem":105,"children":106,"page":17},"Action catalog","\u002Fcatalog","6.catalog",[107],{"title":108,"path":109,"stem":110},"Find and use Actions","\u002Fcatalog\u002Foverview","6.catalog\u002F1.overview",{"title":112,"path":113,"stem":114,"children":115,"page":17},"Administration","\u002Fadministration","7.administration",[116,120,124,128],{"title":117,"path":118,"stem":119},"Registries and Environments","\u002Fadministration\u002Fenvironments","7.administration\u002F2.environments",{"title":121,"path":122,"stem":123},"Manage runners","\u002Fadministration\u002Frunners","7.administration\u002F3.runners",{"title":125,"path":126,"stem":127},"Access and approval policies","\u002Fadministration\u002Faccess","7.administration\u002F4.access",{"title":129,"path":130,"stem":131},"Backups and upgrades","\u002Fadministration\u002Fmaintenance","7.administration\u002F5.maintenance",{"title":133,"path":134,"stem":135,"children":136,"page":17},"Develop Actions","\u002Factions","8.actions",[137,141,145],{"title":138,"path":139,"stem":140},"Build your first Action","\u002Factions\u002Fquickstart","8.actions\u002F1.quickstart",{"title":142,"path":143,"stem":144},"Local development","\u002Factions\u002Flocal-development","8.actions\u002F2.local-development",{"title":146,"path":147,"stem":148},"Publish an Action","\u002Factions\u002Fpublishing","8.actions\u002F3.publishing",{"title":150,"path":151,"stem":152,"children":153,"page":17},"Reference","\u002Freference","9.reference",[154,158,162,166,170,174,178,182,186,190],{"title":155,"path":156,"stem":157},"Operator CLI","\u002Freference\u002Foperator-cli","9.reference\u002F1.operator-cli",{"title":159,"path":160,"stem":161},"Installer CLI","\u002Freference\u002Finstaller-cli","9.reference\u002F10.installer-cli",{"title":163,"path":164,"stem":165},"Definition syntax","\u002Freference\u002Fdefinition","9.reference\u002F2.definition",{"title":167,"path":168,"stem":169},"CLI configuration","\u002Freference\u002Fconfiguration","9.reference\u002F3.configuration",{"title":171,"path":172,"stem":173},"API integration","\u002Freference\u002Fapi","9.reference\u002F4.api",{"title":175,"path":176,"stem":177},"Action CLI","\u002Freference\u002Faction-cli","9.reference\u002F5.action-cli",{"title":179,"path":180,"stem":181},"Action SDK","\u002Freference\u002Fsdk","9.reference\u002F6.sdk",{"title":183,"path":184,"stem":185},"Contracts and compatibility","\u002Freference\u002Fcontracts","9.reference\u002F7.contracts",{"title":187,"path":188,"stem":189},"Server configuration","\u002Freference\u002Fserver-configuration","9.reference\u002F8.server-configuration",{"title":191,"path":192,"stem":193},"Runner configuration","\u002Freference\u002Frunner-configuration","9.reference\u002F9.runner-configuration",{"id":195,"title":155,"body":196,"description":805,"extension":806,"meta":807,"navigation":808,"path":156,"seo":809,"stem":157,"__hash__":810},"docs\u002F9.reference\u002F1.operator-cli.md",{"type":197,"value":198,"toc":798},"minimark",[199,217,228,245,250,341,348,352,443,447,595,615,618,621,776,787,794],[200,201,202,203,207,208,211,212,216],"p",{},"The ",[204,205,206],"code",{},"pyplines"," command is installed by the ",[204,209,210],{},"pyplines-cli"," Python distribution. It requires Python 3.12 or newer. Use the supported tooling version shown in this site. See the ",[213,214,215],"a",{"href":15},"quickstart"," for installation.",[200,218,219,220,223,224,227],{},"Run ",[204,221,222],{},"pyplines --help"," or append ",[204,225,226],{},"--help"," to a command for all flags. Global options precede the command:",[229,230,236],"pre",{"className":231,"code":232,"filename":233,"language":234,"meta":235,"style":235},"language-sh shiki shiki-themes pyplines-light pyplines-light pyplines-dark","pyplines --json --server https:\u002F\u002Fpyplines.example.com run info 42\n","Terminal","sh","",[204,237,238],{"__ignoreMap":235},[239,240,243],"span",{"class":241,"line":242},"line",1,[239,244,232],{},[246,247,249],"h2",{"id":248},"connection-and-configuration","Connection and configuration",[251,252,253,266],"table",{},[254,255,256],"thead",{},[257,258,259,263],"tr",{},[260,261,262],"th",{},"Command",[260,264,265],{},"Purpose",[267,268,269,280,290,300,310,320],"tbody",{},[257,270,271,277],{},[272,273,274],"td",{},[204,275,276],{},"login URL --username NAME",[272,278,279],{},"Prompt for a password and save a server session",[257,281,282,287],{},[272,283,284],{},[204,285,286],{},"logout",[272,288,289],{},"Revoke the session and remove its local saved token",[257,291,292,297],{},[272,293,294],{},[204,295,296],{},"version",[272,298,299],{},"Print the installed operator CLI version",[257,301,302,307],{},[272,303,304],{},[204,305,306],{},"config show",[272,308,309],{},"Show saved settings",[257,311,312,317],{},[272,313,314],{},[204,315,316],{},"config get KEY",[272,318,319],{},"Read an effective supported setting",[257,321,322,331],{},[272,323,324,327,328],{},[204,325,326],{},"config set KEY VALUE"," \u002F ",[204,329,330],{},"config unset KEY",[272,332,333,334,337,338],{},"Change ",[204,335,336],{},"server"," or ",[204,339,340],{},"tls.ca_file",[200,342,343,344,347],{},"See ",[213,345,346],{"href":168},"configuration"," for precedence and credential storage.",[246,349,351],{"id":350},"definitions-and-deployments","Definitions and deployments",[251,353,354,363],{},[254,355,356],{},[257,357,358,360],{},[260,359,262],{},[260,361,362],{},"Important options and behavior",[267,364,365,375,394,407,418,428],{},[257,366,367,372],{},[272,368,369],{},[204,370,371],{},"validate FILE",[272,373,374],{},"Check local structure; the server remains authoritative",[257,376,377,382],{},[272,378,379],{},[204,380,381],{},"deploy FILE --environment NAME",[272,383,384,387,388,387,391],{},[204,385,386],{},"--as NAME",", ",[204,389,390],{},"--revision N",[204,392,393],{},"--key KEY",[257,395,396,401],{},[272,397,398],{},[204,399,400],{},"list",[272,402,403,404],{},"Optional ",[204,405,406],{},"--environment NAME",[257,408,409,414],{},[272,410,411],{},[204,412,413],{},"info ENVIRONMENT\u002FNAME",[272,415,403,416],{},[204,417,390],{},[257,419,420,425],{},[272,421,422],{},[204,423,424],{},"history ENVIRONMENT\u002FNAME",[272,426,427],{},"List deployed revisions",[257,429,430,435],{},[272,431,432],{},[204,433,434],{},"export ENVIRONMENT\u002FNAME",[272,436,403,437,387,439,442],{},[204,438,390],{},[204,440,441],{},"--output FILE","; refuses overwrite",[246,444,446],{"id":445},"runs-and-evidence","Runs and evidence",[251,448,449,457],{},[254,450,451],{},[257,452,453,455],{},[260,454,262],{},[260,456,362],{},[267,458,459,481,498,508,522,532,542,555,565,575,585],{},[257,460,461,466],{},[272,462,463],{},[204,464,465],{},"run start ENVIRONMENT\u002FNAME",[272,467,468,387,471,387,473,387,475,387,478],{},[204,469,470],{},"--inputs FILE",[204,472,390],{},[204,474,393],{},[204,476,477],{},"--wait",[204,479,480],{},"--timeout SECONDS",[257,482,483,488],{},[272,484,485],{},[204,486,487],{},"run list",[272,489,490,387,492,387,495],{},[204,491,406],{},[204,493,494],{},"--page N",[204,496,497],{},"--limit N",[257,499,500,505],{},[272,501,502],{},[204,503,504],{},"run info ID",[272,506,507],{},"Detailed state and available inputs\u002Foutputs",[257,509,510,515],{},[272,511,512],{},[204,513,514],{},"run status ID",[272,516,517,387,520],{},[204,518,519],{},"--watch",[204,521,480],{},[257,523,524,529],{},[272,525,526],{},[204,527,528],{},"run history ID",[272,530,531],{},"Retained events",[257,533,534,539],{},[272,535,536],{},[204,537,538],{},"run attempts ID",[272,540,541],{},"Individual execution attempts",[257,543,544,549],{},[272,545,546],{},[204,547,548],{},"run logs ID STEP",[272,550,551,554],{},[204,552,553],{},"--attempt INVOCATION_ID"," selects historical logs",[257,556,557,562],{},[272,558,559],{},[204,560,561],{},"run approve ID",[272,563,564],{},"Approve prepared work",[257,566,567,572],{},[272,568,569],{},[204,570,571],{},"run retry ID",[272,573,574],{},"Re-prepare a settled blocked step",[257,576,577,582],{},[272,578,579],{},[204,580,581],{},"run skip ID --reason TEXT",[272,583,584],{},"Skip with policy permission",[257,586,587,592],{},[272,588,589],{},[204,590,591],{},"run cancel ID",[272,593,594],{},"Request stop; does not roll back effects",[200,596,597,598,387,601,387,604,607,608,611,612,614],{},"Decision commands accept ",[204,599,600],{},"--step",[204,602,603],{},"--digest",[204,605,606],{},"--reason",", and ",[204,609,610],{},"--yes",". By default they inspect the current step and prompt. Automation using ",[204,613,610],{}," must still satisfy authorization, policy, and prepared-state checks.",[200,616,617],{},"Waiting exits unsuccessfully for blocked, uncertain, or cancelled Runs, and on wait timeout. Timeout or closing the CLI does not cancel server execution.",[246,619,112],{"id":620},"administration",[251,622,623,633],{},[254,624,625],{},[257,626,627,630],{},[260,628,629],{},"Command group",[260,631,632],{},"Operations",[267,634,635,658,677,687,700,710,723,735,745,766],{},[257,636,637,648],{},[272,638,639,387,642,387,645],{},[204,640,641],{},"registry",[204,643,644],{},"environment",[204,646,647],{},"policy",[272,649,650,387,652,387,655],{},[204,651,400],{},[204,653,654],{},"info NAME",[204,656,657],{},"apply FILE",[257,659,660,671],{},[272,661,662,387,665,387,668],{},[204,663,664],{},"user",[204,666,667],{},"team",[204,669,670],{},"access",[272,672,673,387,675],{},[204,674,400],{},[204,676,657],{},[257,678,679,684],{},[272,680,681],{},[204,682,683],{},"user create NAME",[272,685,686],{},"Prompt for and confirm an initial password",[257,688,689,694],{},[272,690,691],{},[204,692,693],{},"registry login NAME --username USER",[272,695,696,697],{},"Prompt for credentials; optional ",[204,698,699],{},"--password-stdin",[257,701,702,707],{},[272,703,704],{},[204,705,706],{},"secret list ENVIRONMENT",[272,708,709],{},"List names and versions, not values",[257,711,712,717],{},[272,713,714],{},[204,715,716],{},"secret set ENVIRONMENT NAME",[272,718,719,720],{},"Prompt for a value; optional ",[204,721,722],{},"--stdin",[257,724,725,730],{},[272,726,727],{},[204,728,729],{},"secret remove ENVIRONMENT NAME --version N",[272,731,732,733],{},"Remove with expected-version protection; optional ",[204,734,610],{},[257,736,737,742],{},[272,738,739],{},[204,740,741],{},"runner list",[272,743,744],{},"Inspect identities and admission",[257,746,747,752],{},[272,748,749],{},[204,750,751],{},"runner enroll NAME",[272,753,754,387,757,387,760,387,763],{},[204,755,756],{},"--pool",[204,758,759],{},"--ttl",[204,761,762],{},"--automatic",[204,764,765],{},"--max-active",[257,767,768,773],{},[272,769,770],{},[204,771,772],{},"runner approve\u002Freject\u002Frevoke\u002Fdrain ID",[272,774,775],{},"Change runner admission or availability",[200,777,778,779,782,783,786],{},"The CLI also lists ",[204,780,781],{},"runner resume",", but the current server rejects that transition; see ",[213,784,785],{"href":122},"runner maintenance",".",[200,788,343,789,791,792,786],{},[213,790,620],{"href":118}," for configuration examples. Custom Action authoring uses the separate ",[213,793,175],{"href":176},[795,796,797],"style",{},"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);}",{"title":235,"searchDepth":799,"depth":799,"links":800},2,[801,802,803,804],{"id":248,"depth":799,"text":249},{"id":350,"depth":799,"text":351},{"id":445,"depth":799,"text":446},{"id":620,"depth":799,"text":112},"Command reference for deploying, executing, and administering Pyplines.","md",{},true,{"title":155,"description":805},"ETxZeWU95jUKozU7V9pj7H_VXsK5jBc7uPiRHKocP-A",[812,814],{"title":146,"path":147,"stem":148,"description":813,"children":-1},"Authenticate to an OCI registry and publish a validated Action image.",{"title":159,"path":160,"stem":161,"description":815,"children":-1},"YAML-driven installation, inspection, diagnosis, and cleanup of named Pyplines targets.",1792213697689]