mirror of
https://github.com/go-task/task.git
synced 2025-03-27 21:48:54 +02:00
1 line
49 KiB
JavaScript
1 line
49 KiB
JavaScript
|
"use strict";(self.webpackChunktaskfile_dev=self.webpackChunktaskfile_dev||[]).push([[582],{3905:function(t,e,n){n.d(e,{Zo:function(){return o},kt:function(){return s}});var a=n(7294);function l(t,e,n){return e in t?Object.defineProperty(t,e,{value:n,enumerable:!0,configurable:!0,writable:!0}):t[e]=n,t}function r(t,e){var n=Object.keys(t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(t);e&&(a=a.filter((function(e){return Object.getOwnPropertyDescriptor(t,e).enumerable}))),n.push.apply(n,a)}return n}function i(t){for(var e=1;e<arguments.length;e++){var n=null!=arguments[e]?arguments[e]:{};e%2?r(Object(n),!0).forEach((function(e){l(t,e,n[e])})):Object.getOwnPropertyDescriptors?Object.defineProperties(t,Object.getOwnPropertyDescriptors(n)):r(Object(n)).forEach((function(e){Object.defineProperty(t,e,Object.getOwnPropertyDescriptor(n,e))}))}return t}function d(t,e){if(null==t)return{};var n,a,l=function(t,e){if(null==t)return{};var n,a,l={},r=Object.keys(t);for(a=0;a<r.length;a++)n=r[a],e.indexOf(n)>=0||(l[n]=t[n]);return l}(t,e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(t);for(a=0;a<r.length;a++)n=r[a],e.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(t,n)&&(l[n]=t[n])}return l}var p=a.createContext({}),m=function(t){var e=a.useContext(p),n=e;return t&&(n="function"==typeof t?t(e):i(i({},e),t)),n},o=function(t){var e=m(t.components);return a.createElement(p.Provider,{value:e},t.children)},k="mdxType",N={inlineCode:"code",wrapper:function(t){var e=t.children;return a.createElement(a.Fragment,{},e)}},u=a.forwardRef((function(t,e){var n=t.components,l=t.mdxType,r=t.originalType,p=t.parentName,o=d(t,["components","mdxType","originalType","parentName"]),k=m(n),u=l,s=k["".concat(p,".").concat(u)]||k[u]||N[u]||r;return n?a.createElement(s,i(i({ref:e},o),{},{components:n})):a.createElement(s,i({ref:e},o))}));function s(t,e){var n=arguments,l=e&&e.mdxType;if("string"==typeof t||l){var r=n.length,i=new Array(r);i[0]=u;var d={};for(var p in e)hasOwnProperty.call(e,p)&&(d[p]=e[p]);d.originalType=t,d[k]="string"==typeof t?t:l,i[1]=d;for(var m=2;m<r;m++)i[m]=n[m];return a.createElement.apply(null,i)}return a.createElement.apply(null,n)}u.displayName="MDXCreateElement"},3500:function(t,e,n){n.r(e),n.d(e,{assets:function(){return p},contentTitle:function(){return i},default:function(){return k},frontMatter:function(){return r},metadata:function(){return d},toc:function(){return m}});var a=n(3117),l=(n(7294),n(3905));const r={slug:"/api/",sidebar_position:4},i="API Reference",d={unversionedId:"api_reference",id:"api_reference",title:"API Reference",description:"CLI",source:"@site/docs/api_reference.md",sourceDirName:".",slug:"/api/",permalink:"/api/",draft:!1,tags:[],version:"current",sidebarPosition:4,frontMatter:{slug:"/api/",sidebar_position:4},sidebar:"tutorialSidebar",previous:{title:"Usage",permalink:"/usage/"},next:{title:"Styleguide",permalink:"/styleguide/"}},p={},m=[{value:"CLI",id:"cli",level:2},{value:"Special Variables",id:"special-variables",level:2},{value:"ENV",id:"env",level:2},{value:"Schema",id:"schema",level:2},{value:"Taskfile",id:"taskfile",level:3},{value:"Include",id:"include",level:3},{value:"Task",id:"task",level:3},{value:"Dependency",id:"dependency",level:3},{value:"Command",id:"command",level:3},{value:"Variable",id:"variable",level:3},{value:"Precondition",id:"precondition",level:3}],o={toc:m};function k(t){let{components:e,...n}=t;return(0,l.kt)("wrapper",(0,a.Z)({},o,n,{components:e,mdxType:"MDXLayout"}),(0,l.kt)("h1",{id:"api-reference"},"API Reference"),(0,l.kt)("h2",{id:"cli"},"CLI"),(0,l.kt)("p",null,"Task command line tool has the following syntax:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-bash"},"task [--flags] [tasks...] [-- CLI_ARGS...]\n")),(0,l.kt)("admonition",{type:"tip"},(0,l.kt)("p",{parentName:"admonition"},"If ",(0,l.kt)("inlineCode",{parentName:"p"},"--")," is given, all remaning arguments will be assigned to a special ",(0,l.kt)("inlineCode",{parentName:"p"},"CLI_ARGS"),"\nvariable")),(0,l.kt)("table"
|