[{"data":1,"prerenderedAt":1145},["ShallowReactive",2],{"docs-nav":3,"cli-commands":159,"docs-\u002Fdocs\u002Fgetting-started\u002Fquick-start":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":19,"body":670,"description":1139,"extension":1140,"meta":1141,"navigation":1142,"path":20,"seo":1143,"stem":21,"__hash__":1144},"docs\u002Fdocs\u002F1.getting-started\u002F2.quick-start.md",{"type":671,"value":672,"toc":1129},"minimark",[673,677,686,706,711,719,724,728,739,749,752,756,768,772,775,803,818,822,826,837,884,888,905,909,942,952,956,960,963,994,1046,1052,1082,1101,1105,1125],[674,675,19],"h1",{"id":676},"quick-start",[678,679,680,681,685],"p",{},"This walkthrough goes from nothing to a live response using the public ",[682,683,684],"strong",{},"Swagger Petstore","\nAPI: it has an OpenAPI spec you can import and a live server you can call.",[678,687,688,689,692,693,697,700,701,705],{},"You'll set everything up in the ",[682,690,691],{},"desktop app",", then run requests from the app or the ",[694,695,696],"code",{},"craftr",[682,698,699],{},"CLI",". The rule of thumb: author in the app (importing specs, declaring variables,\ncreating requests); use the CLI to run and automate. Make sure you've\n",[702,703,704],"a",{"href":16},"installed"," the app first.",[707,708,710],"h2",{"id":709},"_1-create-a-project","1. Create a project",[678,712,713,714,718],{},"Launch API Craft and create a new project, pointing it at an empty folder. This folder ",[715,716,717],"em",{},"is","\nthe project. Commit it like any repo.",[720,721],"screenshot",{"alt":722,"src":723},"Creating a new project and choosing its folder","\u002Fimages\u002Fquick-start\u002F01-new-project.png",[707,725,727],{"id":726},"_2-import-the-spec","2. Import the spec",[678,729,730,731,734,735,738],{},"Start the ",[682,732,733],{},"New API"," wizard. Give the API a slug (",[694,736,737],{},"petstore-api",") and import the spec by URL:",[740,741,746],"pre",{"className":742,"code":744,"language":745},[743],"language-text","https:\u002F\u002Fpetstore3.swagger.io\u002Fapi\u002Fv3\u002Fopenapi.json\n","text",[694,747,744],{"__ignoreMap":748},"",[678,750,751],{},"The wizard imports the spec, maps operations into resources, and lets you review the mapping\nbefore finishing.",[720,753],{"alt":754,"src":755},"New API wizard importing the spec and showing the resource\u002Foperation mapping","\u002Fimages\u002Fquick-start\u002F02-import-spec.png",[757,758,759],"note",{},[678,760,761,762,764,765,767],{},"Some operations import as ",[682,763,315],{},"; that's expected. The heuristics map what they can;\nyou map or ignore the rest from the schema sidebar. See\n",[702,766,53],{"href":54},".",[707,769,771],{"id":770},"_3-declare-the-environment-variables","3. Declare the environment variables",[678,773,774],{},"Requests resolve their host from a variable, and a variable must be declared before it can\nhold a value.",[776,777,778,790],"ol",{},[779,780,781,782,785,786,789],"li",{},"Open the environment panel (",[694,783,784],{},"Alt+2",") and use the schema editor to declare a ",[694,787,788],{},"baseUrl","\nvariable (string, required).",[779,791,792,793,796,797,799,800,767],{},"Give the ",[694,794,795],{},"dev"," environment a value for ",[694,798,788],{},":\n",[694,801,802],{},"https:\u002F\u002Fpetstore3.swagger.io\u002Fapi\u002Fv3",[678,804,805,806,809,810,813,814,817],{},"Do the same for ",[694,807,808],{},"apiKey",", but declare it as a ",[682,811,812],{},"secret"," so its value lands in the gitignored\n",[694,815,816],{},"dev.secrets.env"," instead of the committed environment file. Petstore accepts any value.",[720,819],{"alt":820,"src":821},"Declaring the baseUrl variable and setting its value on the dev environment","\u002Fimages\u002Fquick-start\u002F03-environment.png",[707,823,825],{"id":824},"_4-configure-the-api","4. Configure the API",[678,827,828,829,832,833,836],{},"Importing a spec doesn't configure the API: ",[682,830,831],{},"every new API needs this once",". Select the API\nin the schema sidebar and open its ",[682,834,835],{},"Config"," tab:",[838,839,840,858],"ul",{},[779,841,842,845,846,849,850,853,854,857],{},[682,843,844],{},"Base URL",": set it to ",[694,847,848],{},"{{baseUrl}}",". It is ",[715,851,852],{},"not"," filled in from the spec's ",[694,855,856],{},"servers","\nentry: pointing it at a variable is what lets one API run against dev, staging, and prod\nwithout editing a file.",[779,859,860,863,864,867,868,871,872,875,876,879,880,883],{},[682,861,862],{},"Default Auth",": pick ",[694,865,866],{},"API key",", in ",[694,869,870],{},"header",", named ",[694,873,874],{},"api_key",", with value ",[694,877,878],{},"{{apiKey}}","\n(what Petstore expects). Bearer tokens and ",[702,881,882],{"href":62},"custom script auth","\nare the other options.",[720,885],{"alt":886,"src":887},"The API Config tab with the base URL set to {{baseUrl}} and default API-key auth","\u002Fimages\u002Fquick-start\u002F04-api-config.png",[757,889,890],{},[678,891,892,893,896,897,900,901,767],{},"Both fields take ",[694,894,895],{},"{{variables}}",", so no host and no secret is ever written into a committed\nfile. The default auth is ",[682,898,899],{},"copied into new requests"," as you create them; it seeds them\nrather than wrapping them, so changing it later leaves existing requests untouched. See\n",[702,902,904],{"href":903},"\u002Fdocs\u002Fguides\u002Frequest-instances#defaults-are-a-starting-point","request instances",[707,906,908],{"id":907},"_5-run-your-first-request","5. Run your first request",[678,910,911,912,915,916,919,920,922,923,926,927,930,931,934,935,937,938,941],{},"In the schema sidebar (",[694,913,914],{},"Alt+1","), expand the ",[682,917,918],{},"Pet"," resource and click the ",[682,921,624],{}," operation\n(",[694,924,925],{},"GET \u002Fpet\u002F{petId}","). Enter ",[694,928,929],{},"3"," for ",[694,932,933],{},"petId",", pick the ",[694,936,795],{}," environment in the top bar, and\npress ",[682,939,940],{},"Ctrl+Enter",". The response appears on the right and is saved to history.",[678,943,944,945,948,949,767],{},"Press ",[682,946,947],{},"Ctrl+S"," to save the request as a reusable instance and name it ",[694,950,951],{},"get-pet",[720,953],{"alt":954,"src":955},"Running GET \u002Fpet\u002F{petId} and viewing the response in the response panel","\u002Fimages\u002Fquick-start\u002F05-run-request.png",[707,957,959],{"id":958},"_6-run-it-from-the-cli","6. Run it from the CLI",[678,961,962],{},"A saved instance is just a file, so the CLI can run it against the same project, ideal for\nscripts and CI:",[740,964,968],{"className":965,"code":966,"language":967,"meta":748,"style":748},"language-bash shiki shiki-themes github-light github-dark","craftr req run Pet\u002Fget-pet -e dev\n","bash",[694,969,970],{"__ignoreMap":748},[971,972,974,977,981,984,987,991],"span",{"class":973,"line":666},"line",[971,975,696],{"class":976},"sScJk",[971,978,980],{"class":979},"sZZnC"," req",[971,982,983],{"class":979}," run",[971,985,986],{"class":979}," Pet\u002Fget-pet",[971,988,990],{"class":989},"sj4cs"," -e",[971,992,993],{"class":979}," dev\n",[740,995,998],{"className":996,"code":997,"language":161,"meta":748,"style":748},"language-json shiki shiki-themes github-light github-dark","{\"id\":10,\"name\":\"Rufus\",\"photoUrls\":[\"example.com\"],\"tags\":[]}\n",[694,999,1000],{"__ignoreMap":748},[971,1001,1002,1006,1009,1012,1015,1018,1021,1023,1026,1028,1031,1034,1037,1040,1043],{"class":973,"line":666},[971,1003,1005],{"class":1004},"sVt8B","{",[971,1007,1008],{"class":989},"\"id\"",[971,1010,1011],{"class":1004},":",[971,1013,1014],{"class":989},"10",[971,1016,1017],{"class":1004},",",[971,1019,1020],{"class":989},"\"name\"",[971,1022,1011],{"class":1004},[971,1024,1025],{"class":979},"\"Rufus\"",[971,1027,1017],{"class":1004},[971,1029,1030],{"class":989},"\"photoUrls\"",[971,1032,1033],{"class":1004},":[",[971,1035,1036],{"class":979},"\"example.com\"",[971,1038,1039],{"class":1004},"],",[971,1041,1042],{"class":989},"\"tags\"",[971,1044,1045],{"class":1004},":[]}\n",[678,1047,1048,1049,1011],{},"The body prints to stdout, so it pipes straight into ",[694,1050,1051],{},"jq",[740,1053,1055],{"className":965,"code":1054,"language":967,"meta":748,"style":748},"craftr req run Pet\u002Fget-pet -e dev | jq '.name'\n",[694,1056,1057],{"__ignoreMap":748},[971,1058,1059,1061,1063,1065,1067,1069,1072,1076,1079],{"class":973,"line":666},[971,1060,696],{"class":976},[971,1062,980],{"class":979},[971,1064,983],{"class":979},[971,1066,986],{"class":979},[971,1068,990],{"class":989},[971,1070,1071],{"class":979}," dev",[971,1073,1075],{"class":1074},"szBVR"," |",[971,1077,1078],{"class":976}," jq",[971,1080,1081],{"class":979}," '.name'\n",[757,1083,1084],{},[678,1085,1086,1087,1090,1091,1094,1095,1098,1099,767],{},"Project scaffolding and spec import are scriptable too (",[694,1088,1089],{},"craftr project init",", ",[694,1092,1093],{},"craftr api create",",\n",[694,1096,1097],{},"craftr schema import","), which is handy in CI. The CLI focuses on running and automation;\nauthoring (declaring variables, creating requests) lives in the app. See the\n",[702,1100,143],{"href":144},[707,1102,1104],{"id":1103},"what-next","What next",[838,1106,1107,1112,1117],{},[779,1108,1109,1111],{},[702,1110,23],{"href":24},": the model behind resources, instances, and environments.",[779,1113,1114,1116],{},[702,1115,57],{"href":58},": overriding params, visibility,\nrunning from CI.",[779,1118,1119,1121,1122,1124],{},[702,1120,143],{"href":144},": every ",[694,1123,696],{}," command.",[1126,1127,1128],"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 .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":748,"searchDepth":1130,"depth":1130,"links":1131},2,[1132,1133,1134,1135,1136,1137,1138],{"id":709,"depth":1130,"text":710},{"id":726,"depth":1130,"text":727},{"id":770,"depth":1130,"text":771},{"id":824,"depth":1130,"text":825},{"id":907,"depth":1130,"text":908},{"id":958,"depth":1130,"text":959},{"id":1103,"depth":1130,"text":1104},"Import a public OpenAPI spec and run your first request in a few minutes.","md",{},null,{"title":19,"description":1139},"JcI4LSSUk3xUxyN60YHxTQ8PEulYnNd2Ftke0kuDBlQ",1789469405930]