[{"data":1,"prerenderedAt":1228},["ShallowReactive",2],{"docs-nav":3,"cli-commands":159,"docs-\u002Fdocs\u002Fgetting-started\u002Finstallation":668},[4],{"title":5,"path":6,"stem":7,"children":8},"Docs","\u002Fdocs","docs",[9,22,47,80,101,142,146],{"title":10,"path":11,"stem":12,"children":13},"Getting Started","\u002Fdocs\u002Fgetting-started","docs\u002F1.getting-started\u002Findex",[14,18],{"title":15,"path":16,"stem":17},"Installation","\u002Fdocs\u002Fgetting-started\u002Finstallation","docs\u002F1.getting-started\u002F1.installation",{"title":19,"path":20,"stem":21},"Quick start","\u002Fdocs\u002Fgetting-started\u002Fquick-start","docs\u002F1.getting-started\u002F2.quick-start",{"title":23,"path":24,"stem":25,"children":26},"Concepts","\u002Fdocs\u002Fconcepts","docs\u002F2.concepts\u002Findex",[27,31,35,39,43],{"title":28,"path":29,"stem":30},"Files-first","\u002Fdocs\u002Fconcepts\u002Ffiles-first","docs\u002F2.concepts\u002F1.files-first",{"title":32,"path":33,"stem":34},"The hierarchy","\u002Fdocs\u002Fconcepts\u002Fhierarchy","docs\u002F2.concepts\u002F2.hierarchy",{"title":36,"path":37,"stem":38},"OpenAPI as the source of truth","\u002Fdocs\u002Fconcepts\u002Fopenapi-source-of-truth","docs\u002F2.concepts\u002F3.openapi-source-of-truth",{"title":40,"path":41,"stem":42},"Instance visibility","\u002Fdocs\u002Fconcepts\u002Finstance-visibility","docs\u002F2.concepts\u002F4.instance-visibility",{"title":44,"path":45,"stem":46},"Environments","\u002Fdocs\u002Fconcepts\u002Fenvironments","docs\u002F2.concepts\u002F5.environments",{"title":48,"path":49,"stem":50,"children":51},"Guides","\u002Fdocs\u002Fguides","docs\u002F3.guides\u002Findex",[52,56,60,64,68,72,76],{"title":53,"path":54,"stem":55},"Importing a spec","\u002Fdocs\u002Fguides\u002Fimporting-a-spec","docs\u002F3.guides\u002F1.importing-a-spec",{"title":57,"path":58,"stem":59},"Request instances","\u002Fdocs\u002Fguides\u002Frequest-instances","docs\u002F3.guides\u002F2.request-instances",{"title":61,"path":62,"stem":63},"Auth & middlewares","\u002Fdocs\u002Fguides\u002Fauth-and-middlewares","docs\u002F3.guides\u002F3.auth-and-middlewares",{"title":65,"path":66,"stem":67},"Writing workflows","\u002Fdocs\u002Fguides\u002Fwriting-workflows","docs\u002F3.guides\u002F4.writing-workflows",{"title":69,"path":70,"stem":71},"CI\u002FCD","\u002Fdocs\u002Fguides\u002Fci-cd","docs\u002F3.guides\u002F5.ci-cd",{"title":73,"path":74,"stem":75},"Documenting an API","\u002Fdocs\u002Fguides\u002Fdocumenting-an-api","docs\u002F3.guides\u002F6.documenting-an-api",{"title":77,"path":78,"stem":79},"Pro license","\u002Fdocs\u002Fguides\u002Fpro-license","docs\u002F3.guides\u002F7.pro-license",{"title":81,"path":82,"stem":83,"children":84},"Interface","\u002Fdocs\u002Finterface","docs\u002F4.interface\u002Findex",[85,89,93,97],{"title":86,"path":87,"stem":88},"Navigation","\u002Fdocs\u002Finterface\u002Fnavigation","docs\u002F4.interface\u002F1.navigation",{"title":90,"path":91,"stem":92},"History","\u002Fdocs\u002Finterface\u002Fhistory","docs\u002F4.interface\u002F2.history",{"title":94,"path":95,"stem":96},"Command palette","\u002Fdocs\u002Finterface\u002Fcommand-palette","docs\u002F4.interface\u002F3.command-palette",{"title":98,"path":99,"stem":100},"Keyboard shortcuts","\u002Fdocs\u002Finterface\u002Fkeyboard-shortcuts","docs\u002F4.interface\u002F4.keyboard-shortcuts",{"title":102,"path":103,"stem":104,"children":105},"Reference","\u002Fdocs\u002Freference","docs\u002F5.reference\u002Findex",[106],{"title":107,"path":108,"stem":109,"children":110},"File formats","\u002Fdocs\u002Freference\u002Ffile-formats","docs\u002F5.reference\u002F1.file-formats\u002Findex",[111,115,119,123,126,130,134,138],{"title":112,"path":113,"stem":114},"config.json","\u002Fdocs\u002Freference\u002Ffile-formats\u002Fconfig-json","docs\u002F5.reference\u002F1.file-formats\u002F1.config-json",{"title":116,"path":117,"stem":118},"api.json","\u002Fdocs\u002Freference\u002Ffile-formats\u002Fapi-json","docs\u002F5.reference\u002F1.file-formats\u002F2.api-json",{"title":120,"path":121,"stem":122},"_resource.json","\u002Fdocs\u002Freference\u002Ffile-formats\u002Fresource-json","docs\u002F5.reference\u002F1.file-formats\u002F3.resource-json",{"title":57,"path":124,"stem":125},"\u002Fdocs\u002Freference\u002Ffile-formats\u002Frequest-instance","docs\u002F5.reference\u002F1.file-formats\u002F4.request-instance",{"title":127,"path":128,"stem":129},"Environment files","\u002Fdocs\u002Freference\u002Ffile-formats\u002Fenvironment-schema","docs\u002F5.reference\u002F1.file-formats\u002F5.environment-schema",{"title":131,"path":132,"stem":133},"schema.rules.json","\u002Fdocs\u002Freference\u002Ffile-formats\u002Fschema-rules","docs\u002F5.reference\u002F1.file-formats\u002F6.schema-rules",{"title":135,"path":136,"stem":137},"Documentation files","\u002Fdocs\u002Freference\u002Ffile-formats\u002Fdocumentation","docs\u002F5.reference\u002F1.file-formats\u002F7.documentation",{"title":139,"path":140,"stem":141},"Workflow files","\u002Fdocs\u002Freference\u002Ffile-formats\u002Fworkflow","docs\u002F5.reference\u002F1.file-formats\u002F8.workflow",{"title":143,"path":144,"stem":145},"CLI reference","\u002Fdocs\u002Fcli","docs\u002F6.cli\u002Findex",{"title":147,"path":148,"stem":149,"children":150},"Plugins","\u002Fdocs\u002Fplugins","docs\u002F7.plugins\u002Findex",[151,155],{"title":152,"path":153,"stem":154},"Using plugins","\u002Fdocs\u002Fplugins\u002Fusing-plugins","docs\u002F7.plugins\u002F1.using-plugins",{"title":156,"path":157,"stem":158},"Writing a plugin","\u002Fdocs\u002Fplugins\u002Fwriting-a-plugin","docs\u002F7.plugins\u002F2.writing-a-plugin",{"id":160,"extension":161,"meta":162,"namespaces":163,"stem":665,"version":666,"__hash__":667},"cliCommands\u002Fdata\u002Fcli-commands.json","json",{},[164,201,277,406,422,501,537,608,640],{"namespace":165,"description":166,"commands":167,"seeAlso":198},"project","Create and validate an API Craft project.",[168,178,183,192],{"name":169,"usage":170,"description":171,"flags":172,"examples":176},"init","craftr project init \u003Cname> [--private]","Initialize an API Craft project in the current directory.",[173],{"name":174,"description":175},"--private","Mark the project as private (gitignore the apis directory and .api-craft).",[177],"craftr project init \"Petstore Project\"",{"name":179,"usage":180,"description":181,"flags":182},"validate","craftr project validate","Validate the project structure and report problems.",[],{"name":184,"usage":185,"description":186,"examples":187,"seeAlso":188},"trust","craftr project trust","Approve this project so its scripts (middlewares, custom auth, workflow scripts) can run. Persists until untrusted.",[185],[189],{"label":190,"to":191},"Auth & middlewares: middlewares","\u002Fdocs\u002Fguides\u002Fauth-and-middlewares#middlewares",{"name":193,"usage":194,"description":195,"seeAlso":196},"untrust","craftr project untrust","Refuse this project, blocking its scripts until it is trusted again.",[197],{"label":190,"to":191},[199,200],{"label":28,"to":29},{"label":19,"to":20},{"namespace":202,"description":203,"commands":204,"seeAlso":273},"api","Manage APIs and their default auth and overrides.",[205,210,223,229,242,261,267],{"name":206,"usage":207,"description":208,"flags":209},"list","craftr api list","List the APIs in the project.",[],{"name":211,"usage":212,"description":213,"flags":214,"examples":220},"create","craftr api create --api \u003Capi>","Create a new API.",[215],{"name":216,"short":217,"description":218,"takesValue":219,"required":219},"--api","-a","API slug.",true,[221,222],"craftr api create --api petstore-api","craftr api create -a petstore-api",{"name":224,"usage":225,"description":226,"flags":227},"delete","craftr api delete --api \u003Capi>","Delete an API.",[228],{"name":216,"short":217,"description":218,"takesValue":219,"required":219},{"name":230,"usage":231,"description":232,"flags":233,"examples":238,"seeAlso":240},"set auth bearer","craftr api set auth bearer --token \u003Ctoken> [--api \u003Capi>]","Set the API default auth to a bearer token. Supports {{variables}}.",[234,237],{"name":235,"description":236,"takesValue":219,"required":219},"--token","Bearer token value. Supports {{variables}}.",{"name":216,"short":217,"description":218,"takesValue":219},[239],"craftr api set auth bearer --token \"{{apiKey}}\" --api petstore-api",[241],{"label":61,"to":62},{"name":243,"usage":244,"description":245,"flags":246,"examples":257,"seeAlso":259},"set auth api-key","craftr api set auth api-key --in \u003Cheader|query> --name \u003Cname> --value \u003Cvalue> [--api \u003Capi>]","Set the API default auth to an API key sent as a header or query parameter.",[247,250,253,256],{"name":248,"description":249,"takesValue":219,"required":219},"--in","Where to send the key: header or query.",{"name":251,"description":252,"takesValue":219,"required":219},"--name","Header or query parameter name.",{"name":254,"description":255,"takesValue":219,"required":219},"--value","API key value. Supports {{variables}}.",{"name":216,"short":217,"description":218,"takesValue":219},[258],"craftr api set auth api-key --in header --name api_key --value \"{{apiKey}}\" -a petstore-api",[260],{"label":61,"to":62},{"name":262,"usage":263,"description":264,"flags":265},"unset auth","craftr api unset auth [--api \u003Capi>]","Clear the API default auth.",[266],{"name":216,"short":217,"description":218,"takesValue":219},{"name":268,"usage":269,"description":270,"flags":271},"overrides","craftr api overrides [--api \u003Capi>]","List all overrides for an API, grouped by kind (api, resource, operation, parameter).",[272],{"name":216,"short":217,"description":218,"takesValue":219},[274,275],{"label":61,"to":62},{"label":276,"to":117},"api.json format",{"namespace":278,"description":279,"commands":280,"seeAlso":403},"schema","Import an OpenAPI spec and manage the resource\u002Foperation mapping.",[281,302,308,314,320,326,334,349,355,361,370,376,382,397],{"name":282,"usage":283,"description":284,"flags":285,"examples":297,"seeAlso":300},"import","craftr schema import [source] [--api \u003Capi>] [--yes] [--no-persist-source] [--no-auto-clear-caught-up]","Import an OpenAPI spec: preview the diff, resolve conflicts, write, and remap. Source may be a file path or URL; omit to use the saved source or piped stdin.",[286,287,291,294],{"name":216,"short":217,"description":218,"takesValue":219},{"name":288,"short":289,"description":290},"--yes","-y","Skip the apply confirmation (required for non-interactive use).",{"name":292,"description":293},"--no-persist-source","Do not persist the spec source in api.json when a path or URL is given. Ignored for stdin and for a saved source.",{"name":295,"description":296},"--no-auto-clear-caught-up","Keep overrides whose value already matches the new source.",[298,299],"craftr schema import .\u002Fopenapi.json -a petstore-api","craftr schema import https:\u002F\u002Fpetstore3.swagger.io\u002Fapi\u002Fv3\u002Fopenapi.json -a petstore-api --yes",[301],{"label":53,"to":54},{"name":303,"usage":304,"description":305,"flags":306},"diff","craftr schema diff [source] [--api \u003Capi>]","Preview the diff between the current schema and a candidate spec. Uses the persisted source if no path is given.",[307],{"name":216,"short":217,"description":218,"takesValue":219},{"name":309,"usage":310,"description":311,"flags":312},"read","craftr schema read [--api \u003Capi>]","Read the effective schema (resources, unmapped, ignored, orphan rules).",[313],{"name":216,"short":217,"description":218,"takesValue":219},{"name":315,"usage":316,"description":317,"flags":318},"unmapped","craftr schema unmapped [--api \u003Capi>]","List operations that are not mapped to any resource.",[319],{"name":216,"short":217,"description":218,"takesValue":219},{"name":321,"usage":322,"description":323,"flags":324},"ignored","craftr schema ignored [--api \u003Capi>]","List ignored operations with their rule ids.",[325],{"name":216,"short":217,"description":218,"takesValue":219},{"name":327,"usage":328,"description":329,"flags":330,"examples":332},"map","craftr schema map \u003Coperation-id> \u003Cresource> \u003Coperation> [--api \u003Capi>]","Map an unmapped operation to a resource and operation name.",[331],{"name":216,"short":217,"description":218,"takesValue":219},[333],"craftr schema map updatePetWithForm Pet updateWithForm -a petstore-api",{"name":335,"usage":336,"description":337,"flags":338},"map-all","craftr schema map-all (--from \u003Cfile> | --default | --skip-all) [--api \u003Capi>]","Bulk-map every unmapped operation. Choose exactly one mode.",[339,342,345,348],{"name":340,"description":341,"takesValue":219},"--from","Path to a JSON array of {operationId, resource, operation, skip?}. Use \"-\" for stdin.",{"name":343,"description":344},"--default","Apply heuristic defaults to every unmapped operation.",{"name":346,"description":347},"--skip-all","Add an ignore rule for every unmapped operation.",{"name":216,"short":217,"description":218,"takesValue":219},{"name":350,"usage":351,"description":352,"flags":353},"rename operation","craftr schema rename operation \u003Cresource> \u003Coperation-name> \u003Cnew-name> [--api \u003Capi>]","Rename a single operation within a resource.",[354],{"name":216,"short":217,"description":218,"takesValue":219},{"name":356,"usage":357,"description":358,"flags":359},"rename resource","craftr schema rename resource \u003Cold-slug> \u003Cnew-slug> [--api \u003Capi>]","Rename a resource.",[360],{"name":216,"short":217,"description":218,"takesValue":219},{"name":362,"usage":363,"description":364,"flags":365},"set-parent","craftr schema set-parent \u003Cresource> [parent] [--clear] [--api \u003Capi>]","Set or clear the parent of a resource. Provide a parent or pass --clear, not both.",[366,369],{"name":367,"description":368},"--clear","Clear the parent instead of setting it.",{"name":216,"short":217,"description":218,"takesValue":219},{"name":371,"usage":372,"description":373,"flags":374},"ignore","craftr schema ignore \u003Coperation-id> [--api \u003Capi>]","Ignore an operation. It is removed from the effective schema.",[375],{"name":216,"short":217,"description":218,"takesValue":219},{"name":377,"usage":378,"description":379,"flags":380},"unignore","craftr schema unignore \u003Coperation-id> [--api \u003Capi>]","Remove an ignore rule by operationId.",[381],{"name":216,"short":217,"description":218,"takesValue":219},{"name":383,"usage":384,"description":385,"flags":386},"define","craftr schema define \u003Cresource> \u003Cname> --method \u003Cmethod> --path \u003Cpath> --operation-id \u003Cid> [--api \u003Capi>]","Define a local operation that does not exist in the source spec. Creates the resource if new.",[387,390,393,396],{"name":388,"description":389,"takesValue":219,"required":219},"--method","HTTP method (GET, POST, …).",{"name":391,"description":392,"takesValue":219,"required":219},"--path","OpenAPI path, e.g. \u002Fpet\u002F{petId}\u002Fvaccinations.",{"name":394,"description":395,"takesValue":219,"required":219},"--operation-id","Unique operationId.",{"name":216,"short":217,"description":218,"takesValue":219},{"name":398,"usage":399,"description":400,"flags":401},"undefine","craftr schema undefine \u003Cresource> \u003Cname> [--api \u003Capi>]","Delete a locally-defined operation.",[402],{"name":216,"short":217,"description":218,"takesValue":219},[404,405],{"label":53,"to":54},{"label":36,"to":37},{"namespace":407,"description":408,"commands":409,"seeAlso":420},"spec","Read the OpenAPI spec.",[410],{"name":309,"usage":411,"description":412,"flags":413,"examples":418},"craftr spec read [--api \u003Capi>] [--imported]","Print the effective OpenAPI spec, or the raw imported spec with --imported.",[414,415],{"name":216,"short":217,"description":218,"takesValue":219},{"name":416,"description":417},"--imported","Print the raw imported spec (spec.imported.json) instead of the projected one.",[419],"craftr spec read -a petstore-api | jq '.paths | keys'",[421],{"label":36,"to":37},{"namespace":423,"description":424,"commands":425,"seeAlso":497},"req","List, run, and manage request instances.",[426,439,474,480,486],{"name":206,"usage":427,"description":428,"flags":429},"craftr req list [--resource \u003Cresource>] [--filter \u003Ctext>] [--api \u003Capi>]","List request instances, optionally filtered.",[430,434,438],{"name":431,"short":432,"description":433,"takesValue":219},"--resource","-r","Resource slug to list. Omit to list every request.",{"name":435,"short":436,"description":437,"takesValue":219},"--filter","-f","Case-insensitive substring matched against resource and request name.",{"name":216,"short":217,"description":218,"takesValue":219},{"name":440,"usage":441,"description":442,"flags":443,"examples":465,"seeAlso":469},"run","craftr req run \u003Cresource\u002Fname> --env \u003Cenv> [--api \u003Capi>] [--var \u003Ck=v>…] [--set \u003Cns.k=v>…] [--full] [--trust] [--verbose]","Execute a request instance against an environment. Prints the response body by default.",[444,448,449,452,455,458,461],{"name":445,"short":446,"description":447,"takesValue":219,"required":219},"--env","-e","Environment name.",{"name":216,"short":217,"description":218,"takesValue":219},{"name":450,"description":451,"takesValue":219,"repeatable":219},"--var","Override an environment variable: key=value. The variable must be declared in the environment schema.",{"name":453,"description":454,"takesValue":219,"repeatable":219},"--set","Override a request parameter: \u003Cpath|query|header|body>.key=value. Body keys support dot-notation.",{"name":456,"description":457},"--full","Print the full execution result instead of just the response body.",{"name":459,"description":460},"--trust","Allow this project's scripts to run for this invocation only. Never saved.",{"name":462,"short":463,"description":464},"--verbose","-v","Print the trace to stderr. -v is info, -vv adds debug.",[466,467,468],"craftr req run Pet\u002Fget-pet -e dev","craftr req run Pet\u002Fget-pet -e dev --set path.petId=3 | jq '.name'","craftr req run Pet\u002Fget-pet -e dev --var apiKey=sk-test --full",[470,473],{"label":471,"to":472},"Request instances: running","\u002Fdocs\u002Fguides\u002Frequest-instances#running",{"label":69,"to":70},{"name":475,"usage":476,"description":477,"flags":478},"duplicate","craftr req duplicate \u003Cresource\u002Fname> \u003Cnew-name> [--api \u003Capi>]","Duplicate a request instance. The copy is created as private.",[479],{"name":216,"short":217,"description":218,"takesValue":219},{"name":481,"usage":482,"description":483,"flags":484},"rename","craftr req rename \u003Cresource\u002Fname> \u003Cnew-name> [--api \u003Capi>]","Rename a request instance.",[485],{"name":216,"short":217,"description":218,"takesValue":219},{"name":487,"usage":488,"description":489,"flags":490,"seeAlso":495},"set-visibility","craftr req set-visibility \u003Cresource\u002Fname> \u003Cpublic|private> [--new-name \u003Cname>] [--api \u003Capi>]","Change a request instance's visibility (public or private).",[491,494],{"name":492,"description":493,"takesValue":219},"--new-name","Rename the request as it changes visibility.",{"name":216,"short":217,"description":218,"takesValue":219},[496],{"label":40,"to":41},[498,499],{"label":57,"to":58},{"label":500,"to":124},"Request instance format",{"namespace":502,"description":503,"commands":504,"seeAlso":533},"env","Manage environments and their values.",[505,510,515,523,528],{"name":206,"usage":506,"description":507,"flags":508},"craftr env list [--api \u003Capi>]","List environments.",[509],{"name":216,"short":217,"description":218,"takesValue":219},{"name":309,"usage":511,"description":512,"flags":513},"craftr env read \u003Cenv> [--api \u003Capi>]","Read an environment's values, with the extends chain resolved.",[514],{"name":216,"short":217,"description":218,"takesValue":219},{"name":516,"usage":517,"description":518,"flags":519,"examples":521},"write","craftr env write \u003Cenv> \u003Ckey> \u003Cvalue> [--api \u003Capi>]","Write a single environment variable. The value is JSON-parsed if it is a valid scalar, otherwise stored as a string.",[520],{"name":216,"short":217,"description":218,"takesValue":219},[522],"craftr env write dev baseUrl https:\u002F\u002Fpetstore3.swagger.io\u002Fapi\u002Fv3",{"name":224,"usage":524,"description":525,"flags":526},"craftr env delete \u003Cenv> [--api \u003Capi>]","Delete an environment.",[527],{"name":216,"short":217,"description":218,"takesValue":219},{"name":481,"usage":529,"description":530,"flags":531},"craftr env rename \u003Cold-name> \u003Cnew-name> [--api \u003Capi>]","Rename an environment.",[532],{"name":216,"short":217,"description":218,"takesValue":219},[534,535],{"label":44,"to":45},{"label":536,"to":128},"Environment schema format",{"namespace":538,"description":539,"commands":540,"seeAlso":604},"workflow","Run project-scoped workflows.",[541,574,578,584,595,598,601],{"name":440,"usage":542,"description":543,"flags":544,"examples":565,"seeAlso":569},"craftr workflow run [\u003Cworkflow>...] [--all] --env \u003Capi>=\u003Cenv> [--input ...] [--concurrency \u003Cn>] [--on-failure halt|continue] [--full-output \u003Cfile>] [--trust]","Run one or more workflows (or every workflow with --all) and aggregate the results. Prints a JSON summary report on stdout, a human summary on stderr, and exits 1 if any workflow failed (130 if cancelled).",[545,548,550,553,556,559,561,564],{"name":546,"description":547},"--all","Run every workflow in the project. Mutually exclusive with named workflows.",{"name":445,"short":446,"description":549,"takesValue":219,"required":219,"repeatable":219},"Bind an environment to an API: \u003Capi>=\u003Cenv>. Repeat once per API the run touches (the union across a batch).",{"name":551,"description":552,"takesValue":219,"repeatable":219},"--input","Workflow input: [\u003Cworkflow>:]\u003Ckey>=\u003Cvalue>. Without a workflow prefix it applies to every workflow in the batch.",{"name":554,"description":555,"takesValue":219},"--concurrency","Workflows in flight at once (default 4). 1 runs them sequentially.",{"name":557,"description":558,"takesValue":219},"--on-failure","halt stops starting new workflows after a failure; continue (default) runs them all. Separate from a workflow file's own onFailure, which governs blocks within a run.",{"name":462,"short":463,"description":560},"Progress and traces to stderr: -v workflow level, -vv block logs, -vvv debug.",{"name":562,"description":563,"takesValue":219},"--full-output","Write the complete run result (every block and response) to this file. Omitted, that detail is discarded.",{"name":459,"description":460},[566,567,568],"craftr workflow run pet-lifecycle --env petstore-api=prod","craftr workflow run publish-and-verify -e petstore-api=prod -e catalog=staging","craftr workflow run --all -e petstore-api=prod -e catalog=staging",[570,573],{"label":571,"to":572},"Writing workflows: from the CLI","\u002Fdocs\u002Fguides\u002Fwriting-workflows#from-the-cli",{"label":69,"to":70},{"name":206,"usage":575,"description":576,"examples":577},"craftr workflow list","List every workflow in the project.",[575],{"name":179,"usage":579,"description":580,"examples":581},"craftr workflow validate [\u003Cworkflow>...]","Check that a workflow's references resolve (api, resource, operation, instance, scripts) and refresh the generated script typings. Omit the name to check every workflow. Sends no request, so it is cheap to run in CI before a run.",[582,583],"craftr workflow validate","craftr workflow validate pet-lifecycle",{"name":585,"usage":586,"description":587,"flags":588,"examples":592},"history","craftr workflow history [\u003Crun-id>] [--limit \u003Cn>]","List past workflow runs newest first, or read one run in full by id. Run ids are the ISO timestamp of the run with \":\" replaced by \"-\".",[589],{"name":590,"description":591,"takesValue":219},"--limit","Keep only the first N summaries. Ignored when an id is given.",[593,594],"craftr workflow history --limit 5","craftr workflow history 2026-08-23T10-14-02.981Z",{"name":481,"usage":596,"description":597},"craftr workflow rename \u003Cold-name> \u003Cnew-name>","Rename a workflow, its scripts directory included.",{"name":475,"usage":599,"description":600},"craftr workflow duplicate \u003Csource-name> \u003Cnew-name>","Duplicate a workflow, its scripts directory included.",{"name":224,"usage":602,"description":603},"craftr workflow delete \u003Cworkflow-name>","Delete a workflow and its scripts directory.",[605,606],{"label":65,"to":66},{"label":607,"to":140},"Workflow file format",{"namespace":609,"description":610,"commands":611,"seeAlso":635},"license","Install, inspect or remove the Pro license. Per user, not per project, so these work from any directory.",[612,623,629],{"name":613,"usage":614,"description":615,"flags":616,"examples":620},"install","craftr license install [--file \u003Cpath>]","Install a license from a file or from stdin. Verifies the signature first; on failure the current license, if any, is left in place.",[617],{"name":618,"description":619,"takesValue":219},"--file","Path to the license file. Reads stdin when omitted.",[621,622],"craftr license install --file=license.key","cat license.key | craftr license install",{"name":624,"usage":625,"description":626,"flags":627,"examples":628},"get","craftr license get","Print the active license state as JSON: status, tier, who it is issued to, expiry, features and limits. A limit of -1 means unlimited.",[],[625],{"name":630,"usage":631,"description":632,"flags":633,"examples":634},"remove","craftr license remove","Delete the installed license and fall back to the Free plan. Prints the resulting state.",[],[631],[636,637],{"label":77,"to":78},{"label":638,"to":639},"Pricing","\u002Fpricing",{"namespace":641,"description":642,"commands":643,"seeAlso":662},"completion","Shell tab-completion management.",[644,654],{"name":613,"usage":645,"description":646,"flags":647,"examples":651},"craftr completion install [--shell \u003Cbash|zsh|fish>]","Install shell tab-completion. Writes the completion script and, for bash and zsh, adds a marked block to the shell rc file that sources it.",[648],{"name":649,"description":650,"takesValue":219},"--shell","bash, zsh or fish. Defaults to the shell named by $SHELL.",[652,653],"craftr completion install","craftr completion install --shell fish",{"name":655,"usage":656,"description":657,"flags":658,"examples":660},"uninstall","craftr completion uninstall [--shell \u003Cbash|zsh|fish>]","Remove the completion script and the block it added to the shell rc file.",[659],{"name":649,"description":650,"takesValue":219},[661],"craftr completion uninstall",[663],{"label":15,"to":664},"\u002Fdocs\u002Fgetting-started\u002Finstallation#tab-completion","data\u002Fcli-commands",1,"wkEyqz4vOf0W24NAkAJY-4EyLZpK5NBQO7YE9JmKeUw",{"id":669,"title":15,"body":670,"description":1222,"extension":1223,"meta":1224,"navigation":1225,"path":16,"seo":1226,"stem":17,"__hash__":1227},"docs\u002Fdocs\u002F1.getting-started\u002F1.installation.md",{"type":671,"value":672,"toc":1215},"minimark",[673,677,681,707,710,715,735,741,760,763,772,781,785,796,803,822,827,830,833,880,883,886,902,905,920,933,936,947,960,964,980,995,1005,1008,1112,1115,1179,1186,1200,1204,1211],[674,675,15],"h1",{"id":676},"installation",[678,679,680],"p",{},"API Craft ships as two pieces. They are independent; install one or both.",[682,683,684,698],"ul",{},[685,686,687,688,692,693,697],"li",{},"The ",[689,690,691],"strong",{},"desktop app"," (",[694,695,696],"code",{},"api-craft","): the graphical IDE.",[685,699,687,700,692,703,706],{},[689,701,702],{},"CLI",[694,704,705],{},"craftr","): the command-line interface, distributed on npm.",[678,708,709],{},"Both run the same core against the same project files, so they interoperate freely.",[711,712,714],"h2",{"id":713},"desktop-app","Desktop app",[716,717,719],"coming-soon",{"title":718},"Public builds",[678,720,721,722,727,728,734],{},"Desktop builds aren't publicly downloadable yet; the ",[723,724,726],"a",{"href":725},"\u002Fdownload","download page"," will carry\nthem as soon as they are. If you'd like a build before then, ask on the\n",[723,729,733],{"href":730,"rel":731},"https:\u002F\u002Fgithub.com\u002Fapicrafthq\u002Fsupport",[732],"nofollow","support repo",".",[678,736,737,738,740],{},"When they land, the ",[723,739,726],{"href":725}," serves an installer per platform:",[682,742,743,752],{},[685,744,745,748,749],{},[689,746,747],{},"macOS",": ",[694,750,751],{},".dmg",[685,753,754,748,757],{},[689,755,756],{},"Linux",[694,758,759],{},".AppImage",[678,761,762],{},"The installer is around 40 MB.",[716,764,766],{"title":765},"Windows app",[678,767,768,769,771],{},"A native Windows build isn't available yet. In the meantime the ",[689,770,702],{}," runs on Windows\n(it's a normal npm package); see below.",[773,774,775],"note",{},[678,776,777,778,780],{},"Every build lives on the ",[723,779,726],{"href":725},". The app is fully local: it does not\nrequire an account or a network connection to use.",[711,782,784],{"id":783},"updates","Updates",[678,786,787,788,791,792,795],{},"The desktop app updates itself. It checks on launch, and ",[689,789,790],{},"Settings → Updates"," has a\n",[689,793,794],{},"Check for updates now"," button for when you don't want to wait.",[678,797,798,799,802],{},"The same tab picks the ",[689,800,801],{},"update channel",":",[682,804,805,811],{},[685,806,807,810],{},[689,808,809],{},"Stable",": tested releases only. The default.",[685,812,813,816,817,821],{},[689,814,815],{},"Beta",": early builds, ",[818,819,820],"em",{},"and"," every stable release. Beta is a superset of stable, not a\nparallel track: you never miss a stable version by being on it.",[823,824],"screenshot",{"alt":825,"src":826},"The Updates tab in Settings: current version, the Stable\u002FBeta channel switch, and the check-now button","\u002Fimages\u002Fgetting-started\u002Fupdate-channel.png",[678,828,829],{},"Switching takes effect at the next check. The choice is stored with the app's own settings,\nnot in any project, so it follows the machine rather than the repository.",[678,831,832],{},"The CLI has the same two channels through npm's dist-tags:",[834,835,840],"pre",{"className":836,"code":837,"language":838,"meta":839,"style":839},"language-bash shiki shiki-themes github-light github-dark","npm install -g @apicrafthq\u002Fcli          # stable\nnpm install -g @apicrafthq\u002Fcli@beta     # beta\n","bash","",[694,841,842,865],{"__ignoreMap":839},[843,844,846,850,854,858,861],"span",{"class":845,"line":666},"line",[843,847,849],{"class":848},"sScJk","npm",[843,851,853],{"class":852},"sZZnC"," install",[843,855,857],{"class":856},"sj4cs"," -g",[843,859,860],{"class":852}," @apicrafthq\u002Fcli",[843,862,864],{"class":863},"sJ8bj","          # stable\n",[843,866,868,870,872,874,877],{"class":845,"line":867},2,[843,869,849],{"class":848},[843,871,853],{"class":852},[843,873,857],{"class":856},[843,875,876],{"class":852}," @apicrafthq\u002Fcli@beta",[843,878,879],{"class":863},"     # beta\n",[711,881,702],{"id":882},"cli",[678,884,885],{},"Install the CLI from npm, globally:",[834,887,889],{"className":836,"code":888,"language":838,"meta":839,"style":839},"npm install -g @apicrafthq\u002Fcli\n",[694,890,891],{"__ignoreMap":839},[843,892,893,895,897,899],{"class":845,"line":666},[843,894,849],{"class":848},[843,896,853],{"class":852},[843,898,857],{"class":856},[843,900,901],{"class":852}," @apicrafthq\u002Fcli\n",[678,903,904],{},"Or run it without installing:",[834,906,908],{"className":836,"code":907,"language":838,"meta":839,"style":839},"npx @apicrafthq\u002Fcli --version\n",[694,909,910],{"__ignoreMap":839},[843,911,912,915,917],{"class":845,"line":666},[843,913,914],{"class":848},"npx",[843,916,860],{"class":852},[843,918,919],{"class":856}," --version\n",[678,921,922,923,925,926,928,929,932],{},"No Node on the machine? The ",[723,924,726],{"href":725}," will also serve standalone ",[694,927,705],{},"\nbinaries for Linux and macOS (x64 and arm64); drop one on your ",[694,930,931],{},"PATH"," and it runs on its own.",[678,934,935],{},"Verify the install:",[834,937,939],{"className":836,"code":938,"language":838,"meta":839,"style":839},"craftr --version\n",[694,940,941],{"__ignoreMap":839},[843,942,943,945],{"class":845,"line":666},[843,944,705],{"class":848},[843,946,919],{"class":856},[773,948,949],{},[678,950,951,952,954,955,957,958,734],{},"The CLI binary is ",[694,953,705],{},". (",[694,956,696],{}," is the desktop app.) Throughout these docs, every\ncommand-line example uses ",[694,959,705],{},[711,961,963],{"id":962},"tab-completion","Tab completion",[678,965,966,968,969,971,972,975,976,979],{},[694,967,705],{}," ships shell completion for ",[689,970,838],{},", ",[689,973,974],{},"zsh"," and ",[689,977,978],{},"fish",". Install it once:",[834,981,983],{"className":836,"code":982,"language":838,"meta":839,"style":839},"craftr completion install\n",[694,984,985],{"__ignoreMap":839},[843,986,987,989,992],{"class":845,"line":666},[843,988,705],{"class":848},[843,990,991],{"class":852}," completion",[843,993,994],{"class":852}," install\n",[678,996,997,998,1001,1002,1004],{},"It picks the shell from ",[694,999,1000],{},"$SHELL","; pass ",[694,1003,649],{}," to choose another. Open a new shell\nafterwards, or re-source your rc file, and completion is live.",[678,1006,1007],{},"What it completes is read from the project you are standing in, not from a static list, so\nit knows your own API slugs, environment names, resource slugs, request references, workflow\nnames, and the operation ids waiting to be mapped:",[834,1009,1011],{"className":836,"code":1010,"language":838,"meta":839,"style":839},"craftr req run Pet\u002F\u003CTAB>          # request instances under the Pet resource\ncraftr env read \u003CTAB>             # dev, staging, prod, prod-eu, prod-eu-client-a\ncraftr workflow run \u003CTAB>         # workflow names\ncraftr workflow run pets --env \u003CTAB>   # \u003Capi>=\u003Cenv> bindings the batch needs\n",[694,1012,1013,1043,1065,1086],{"__ignoreMap":839},[843,1014,1015,1017,1020,1023,1026,1030,1033,1037,1040],{"class":845,"line":666},[843,1016,705],{"class":848},[843,1018,1019],{"class":852}," req",[843,1021,1022],{"class":852}," run",[843,1024,1025],{"class":852}," Pet\u002F",[843,1027,1029],{"class":1028},"szBVR","\u003C",[843,1031,1032],{"class":852},"TA",[843,1034,1036],{"class":1035},"sVt8B","B",[843,1038,1039],{"class":1028},">",[843,1041,1042],{"class":863},"          # request instances under the Pet resource\n",[843,1044,1045,1047,1050,1053,1056,1058,1060,1062],{"class":845,"line":867},[843,1046,705],{"class":848},[843,1048,1049],{"class":852}," env",[843,1051,1052],{"class":852}," read",[843,1054,1055],{"class":1028}," \u003C",[843,1057,1032],{"class":852},[843,1059,1036],{"class":1035},[843,1061,1039],{"class":1028},[843,1063,1064],{"class":863},"             # dev, staging, prod, prod-eu, prod-eu-client-a\n",[843,1066,1068,1070,1073,1075,1077,1079,1081,1083],{"class":845,"line":1067},3,[843,1069,705],{"class":848},[843,1071,1072],{"class":852}," workflow",[843,1074,1022],{"class":852},[843,1076,1055],{"class":1028},[843,1078,1032],{"class":852},[843,1080,1036],{"class":1035},[843,1082,1039],{"class":1028},[843,1084,1085],{"class":863},"         # workflow names\n",[843,1087,1089,1091,1093,1095,1098,1101,1103,1105,1107,1109],{"class":845,"line":1088},4,[843,1090,705],{"class":848},[843,1092,1072],{"class":852},[843,1094,1022],{"class":852},[843,1096,1097],{"class":852}," pets",[843,1099,1100],{"class":856}," --env",[843,1102,1055],{"class":1028},[843,1104,1032],{"class":852},[843,1106,1036],{"class":1035},[843,1108,1039],{"class":1028},[843,1110,1111],{"class":863},"   # \u003Capi>=\u003Cenv> bindings the batch needs\n",[678,1113,1114],{},"Where it lands:",[1116,1117,1118,1134],"table",{},[1119,1120,1121],"thead",{},[1122,1123,1124,1128,1131],"tr",{},[1125,1126,1127],"th",{},"Shell",[1125,1129,1130],{},"Script",[1125,1132,1133],{},"Sourced from",[1135,1136,1137,1153,1167],"tbody",{},[1122,1138,1139,1142,1147],{},[1140,1141,838],"td",{},[1140,1143,1144],{},[694,1145,1146],{},"~\u002F.config\u002Fcraftr\u002Fcompletion.bash",[1140,1148,1149,1150],{},"a marked block appended to ",[694,1151,1152],{},"~\u002F.bashrc",[1122,1154,1155,1157,1162],{},[1140,1156,974],{},[1140,1158,1159],{},[694,1160,1161],{},"~\u002F.config\u002Fcraftr\u002Fcompletion.zsh",[1140,1163,1149,1164],{},[694,1165,1166],{},"~\u002F.zshrc",[1122,1168,1169,1171,1176],{},[1140,1170,978],{},[1140,1172,1173],{},[694,1174,1175],{},"~\u002F.config\u002Ffish\u002Fcompletions\u002Fcraftr.fish",[1140,1177,1178],{},"nothing, fish autoloads it",[678,1180,1181,1182,1185],{},"The rc block is delimited by ",[694,1183,1184],{},"# ###-begin-craftr-completion-###"," markers, so re-running the\ninstall replaces it rather than stacking copies. To remove both the script and the block:",[834,1187,1189],{"className":836,"code":1188,"language":838,"meta":839,"style":839},"craftr completion uninstall\n",[694,1190,1191],{"__ignoreMap":839},[843,1192,1193,1195,1197],{"class":845,"line":666},[843,1194,705],{"class":848},[843,1196,991],{"class":852},[843,1198,1199],{"class":852}," uninstall\n",[711,1201,1203],{"id":1202},"next","Next",[678,1205,1206,1207,1210],{},"Head to the ",[723,1208,1209],{"href":20},"quick start"," to create a project, import a\nspec, and run your first request.",[1212,1213,1214],"style",{},"html pre.shiki code .sScJk, html code.shiki .sScJk{--shiki-default:#6F42C1;--shiki-dark:#B392F0}html pre.shiki code .sZZnC, html code.shiki .sZZnC{--shiki-default:#032F62;--shiki-dark:#9ECBFF}html pre.shiki code .sj4cs, html code.shiki .sj4cs{--shiki-default:#005CC5;--shiki-dark:#79B8FF}html pre.shiki code .sJ8bj, html code.shiki .sJ8bj{--shiki-default:#6A737D;--shiki-dark:#6A737D}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 .szBVR, html code.shiki .szBVR{--shiki-default:#D73A49;--shiki-dark:#F97583}html pre.shiki code .sVt8B, html code.shiki .sVt8B{--shiki-default:#24292E;--shiki-dark:#E1E4E8}",{"title":839,"searchDepth":867,"depth":867,"links":1216},[1217,1218,1219,1220,1221],{"id":713,"depth":867,"text":714},{"id":783,"depth":867,"text":784},{"id":882,"depth":867,"text":702},{"id":962,"depth":867,"text":963},{"id":1202,"depth":867,"text":1203},"Install the API Craft desktop app and the craftr CLI.","md",{},null,{"title":15,"description":1222},"ROzalXJ8S9EHs7l47HcX_YpcUiQxm1UGtVaeJpEX4xg",1789469405909]