{"_id":"54b2c940336cfb0b00608c2a","project":"54b2c91287873d1f00dbebdb","version":{"_id":"54b2c93f336cfb0b00608c28","forked_from":"54b2c91287873d1f00dbebde","project":"54b2c91287873d1f00dbebdb","__v":4,"createdAt":"2015-01-11T19:04:31.031Z","releaseDate":"2015-01-11T19:04:31.031Z","categories":["54b2c93f336cfb0b00608c29","54b2cb87db3c741400eac8c2","54b35d86aad2810b009507d7","54b35d91aad2810b009507d8"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"0.4.0","version":"0.4.0"},"githubsync":"","__v":14,"user":"54a3af95ad78941600ca2e2a","category":{"_id":"54b2c93f336cfb0b00608c29","__v":3,"project":"54b2c91287873d1f00dbebdb","version":"54b2c93f336cfb0b00608c28","pages":["54b2c940336cfb0b00608c2a","54b2cb7687873d1f00dbebe5","54b2cd6487873d1f00dbebea"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-01-11T19:03:47.125Z","from_sync":false,"order":0,"slug":"introduction","title":"Introduction"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-01-11T19:03:47.792Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"To get started with bosco, you need [Node](http://nodejs.org), and then one simple command:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"npm install bosco -g\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\nThis will install bosco globally, and provide you with the 'bosco' command that can be run from anywhere.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"The Setup\"\n}\n[/block]\nNext you need to tell Bosco a little about your github account, as it needs this to be able to pull and manage the repositories linked to your organisations and teams.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"bosco setup\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\nYou will get prompted to create a new configuration folder in your home folder, enter your github user name and then a Github API token:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/p5hv76uNQZmNpe8Nqhaf_Screen%20Shot%202015-01-11%20at%2019.13.50.png\",\n        \"Screen Shot 2015-01-11 at 19.13.50.png\",\n        \"1934\",\n        \"104\",\n        \"#0c343c\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nTo create an api token visit this link:  https://github.com/blog/1509-personal-api-tokens\n\nThis configuration will only be stored locally, and used by all of the subsequent commands.  The first, and most important of which is to create your first workspace.\n\nOnce you have entered these details, bosco will reach out to Github, and pull down a list of all your organisations and teams:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/C3LLErgTi6npY0YYBwg6_Screen%20Shot%202015-01-11%20at%2019.22.03.png\",\n        \"Screen Shot 2015-01-11 at 19.22.03.png\",\n        \"1078\",\n        \"290\",\n        \"#7a9a9a\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nSelect one, and then enter the folder that you want the repositories for this team to be placed (e.g. ~/work/engineering) in the above example - or whatever you like.\n\nBosco will then:\n  * Clone all of the repositories in this team.\n  * Automatically link (npm link) any of the inter dependent projects.\n  * Run npm install on each.\n\nBasically getting the entire project up and running in no time.\n\nNext up, please read: [Daily Routine](doc:daily-routine)","excerpt":"This page will help you get started with bosco. You'll be up and running in no time!","slug":"getting-started","type":"basic","title":"Getting Started"}

Getting Started

This page will help you get started with bosco. You'll be up and running in no time!

To get started with bosco, you need [Node](http://nodejs.org), and then one simple command: [block:code] { "codes": [ { "code": "npm install bosco -g", "language": "shell" } ] } [/block] This will install bosco globally, and provide you with the 'bosco' command that can be run from anywhere. [block:api-header] { "type": "basic", "title": "The Setup" } [/block] Next you need to tell Bosco a little about your github account, as it needs this to be able to pull and manage the repositories linked to your organisations and teams. [block:code] { "codes": [ { "code": "bosco setup", "language": "shell" } ] } [/block] You will get prompted to create a new configuration folder in your home folder, enter your github user name and then a Github API token: [block:image] { "images": [ { "image": [ "https://files.readme.io/p5hv76uNQZmNpe8Nqhaf_Screen%20Shot%202015-01-11%20at%2019.13.50.png", "Screen Shot 2015-01-11 at 19.13.50.png", "1934", "104", "#0c343c", "" ] } ] } [/block] To create an api token visit this link: https://github.com/blog/1509-personal-api-tokens This configuration will only be stored locally, and used by all of the subsequent commands. The first, and most important of which is to create your first workspace. Once you have entered these details, bosco will reach out to Github, and pull down a list of all your organisations and teams: [block:image] { "images": [ { "image": [ "https://files.readme.io/C3LLErgTi6npY0YYBwg6_Screen%20Shot%202015-01-11%20at%2019.22.03.png", "Screen Shot 2015-01-11 at 19.22.03.png", "1078", "290", "#7a9a9a", "" ] } ] } [/block] Select one, and then enter the folder that you want the repositories for this team to be placed (e.g. ~/work/engineering) in the above example - or whatever you like. Bosco will then: * Clone all of the repositories in this team. * Automatically link (npm link) any of the inter dependent projects. * Run npm install on each. Basically getting the entire project up and running in no time. Next up, please read: [Daily Routine](doc:daily-routine)