{"_id":"5619a39a13874c0d007038ee","slug":"getting-started","user":"5617a0a4a410c90d00c612f4","version":"5619a39913874c0d007038e9","__v":16,"githubsync":"","hidden":false,"api":{"url":"","auth":"required","params":[],"results":{"codes":[]},"settings":""},"excerpt":"","link_url":"","category":"5619a39a13874c0d007038ea","createdAt":"2015-10-09T11:16:07.518Z","updates":[],"order":0,"project":"5617a1f5a410c90d00c612f5","sync_unique":"","title":"Getting Started","type":"basic","body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Installation\"\n}\n[/block]\n## Natron CLI\n\n```\n$ npm install natron-cli --global\n```\n\n## Natron\n\n```\n$ npm install natron --save-dev\n```\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Defining Tasks\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"API Stability\",\n  \"body\": \"The API of `v0.2` is currently in _beta_ and is not considered stable, so it may change in future revisions.\"\n}\n[/block]\n## Create a `Natronfile`\n\nFile: **`natronfile.js`**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"module.exports.default = function () {\\n  console.log(\\\"Place code for your default task here\\\");\\n};\",\n      \"language\": \"javascript\",\n      \"name\": \"natronfile.js\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Using Transpilers\",\n  \"body\": \"Natron supports all kinds of languages that transpile to JavaScript, e.g. _ES2015_ or _CoffeScript_.\\nFor more information see [Using Transpilers](/docs/using-transpilers).\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Running Tasks\"\n}\n[/block]\n## Run the `default` Task\n\n```\n$ natron default\n```","link_external":false,"childrenPages":[]}
[block:api-header] { "type": "basic", "title": "Installation" } [/block] ## Natron CLI ``` $ npm install natron-cli --global ``` ## Natron ``` $ npm install natron --save-dev ``` [block:api-header] { "type": "basic", "title": "Defining Tasks" } [/block] [block:callout] { "type": "warning", "title": "API Stability", "body": "The API of `v0.2` is currently in _beta_ and is not considered stable, so it may change in future revisions." } [/block] ## Create a `Natronfile` File: **`natronfile.js`** [block:code] { "codes": [ { "code": "module.exports.default = function () {\n console.log(\"Place code for your default task here\");\n};", "language": "javascript", "name": "natronfile.js" } ] } [/block] [block:callout] { "type": "info", "title": "Using Transpilers", "body": "Natron supports all kinds of languages that transpile to JavaScript, e.g. _ES2015_ or _CoffeScript_.\nFor more information see [Using Transpilers](/docs/using-transpilers)." } [/block] [block:api-header] { "type": "basic", "title": "Running Tasks" } [/block] ## Run the `default` Task ``` $ natron default ```