{"__v":0,"_id":"5821f10f63e87b25000cbcb2","category":{"version":"5821f10e63e87b25000cbc90","project":"570e9147a5da5e0e005fdec3","_id":"5821f10e63e87b25000cbc91","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-04-14T14:28:46.764Z","from_sync":false,"order":0,"slug":"getting-started","title":"Getting Started"},"parentDoc":null,"project":"570e9147a5da5e0e005fdec3","user":"570e90fda5da5e0e005fdec1","version":{"__v":1,"_id":"5821f10e63e87b25000cbc90","project":"570e9147a5da5e0e005fdec3","createdAt":"2016-11-08T15:36:46.296Z","releaseDate":"2016-11-08T15:36:46.296Z","categories":["5821f10e63e87b25000cbc91","5821f10e63e87b25000cbc92","5821f10e63e87b25000cbc93","5821f10e63e87b25000cbc94","5821f10e63e87b25000cbc95","5821f10e63e87b25000cbc96","5821f10e63e87b25000cbc97","5821f10e63e87b25000cbc98","5821f10e63e87b25000cbc99","5821f10e63e87b25000cbc9a","5821f10e63e87b25000cbc9b"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"0.16.0","version":"0.16"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-14T15:37:57.914Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/a24c657-cog_storywheel1.png\",\n        \"cog_storywheel1.png\",\n        720,\n        720,\n        \"#111212\"\n      ],\n      \"caption\": \"Cog + ChatOps = Continuous DevOps\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Cog's Docs are moving!\",\n  \"body\": \"We are in the process of moving and updating all of the content here SO if you see a Depreciation Note on top of the page, please head over to [The Cog Book](http://cog-book.operable.io).\\n\\nThanks for your patience!\\n\\nOperable Team\"\n}\n[/block]\n**Cog** brings the power of the command line to the place you collaborate with your team all the time -- your chat window.\n\nPowerful access control means you can collaborate around even the most sensitive tasks with confidence. A focus on extensibility and adaptability means that you can respond quickly to the unexpected, without your team losing visibility.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/cda51f2-cog1.gif\",\n        \"cog1.gif\",\n        1166,\n        489,\n        \"#d2d2d2\"\n      ],\n      \"caption\": \"Cog being used as part of your workflow.\",\n      \"border\": true\n    }\n  ]\n}\n[/block]\n## Current Features\n\nCog is under heavy development and getting smarter all the time. This list of features gives you an idea of how Cog was built as well as the things that Cog knows how to do.\n[block:html]\n{\n  \"html\": \"<div>\\n<table>\\n  <tr>\\n    <td>\\n        <img src=\\\"http://www.operable.io/assets/img/icons/feature_icons_extensibility.png\\\" class=\\\"center\\\">\\n      <h2 style=\\\"text-align:center;\\\">Extensibility</h2>\\n      <p><ul>\\n        <li>Build new bot commands in any language</li>\\n        <li>Commands return structured data to allow for creative adaptation in pipelines</li>\\n  \\t\\t\\t<li>Built in templating allows the command response to be formatted for the current chat provider without embedding markup in your logic</li>\\n      </ul></p>\\n    </td>\\n<td>\\n  <img src=\\\"http://www.operable.io/assets/img/icons/feature_icons_adaptability.png\\\" class=\\\"center\\\">\\n  <h2 style=\\\"text-align:center;\\\">Adaptability</h2>\\n      <p><ul>\\n        <li>Unix-style pipelines allow you to combine a series of simple commands to solve complex, unexpected problems</li>\\n        <li>Support for output redirection lets you make sure everyone is in the loop</li>\\n      </ul></p>\\n    </td>\\n</tr>\\n  <tr>\\n    <td>\\n        <img src=\\\"http://www.operable.io/assets/img/icons/feature_icons_security.png\\\" class=\\\"center\\\">\\n      <h2 style=\\\"text-align:center;\\\">Security</h2>\\n      <p><ul>\\n        <li>Fine-grained command permissions give you confidence in using chatops for even the most sensitive workflows</li>\\n        <li>Users, Groups, and Roles allow you to organize access control for ease of management</li>\\n  \\t\\t\\t<li>Audit logging for commands and administrative functions let you keep track of everything that happens with Cog</li>\\n      </ul></p>\\n    </td>\\n<td>\\n  <img src=\\\"http://www.operable.io/assets/img/icons/feature_icons_chatagnostic.png\\\" class=\\\"center\\\">\\n  <h2 style=\\\"text-align:center;\\\">Chat-provider agnostic</h2>\\n      <p><ul>\\n        <li>Current support for Slack</li>\\n        <li>HipChat adapter in progress</li>\\n \\t\\t\\t\\t<li>...other chat clients are on the roadmap!</li>\\n      </ul></p>\\n    </td>\\n</tr>\\n</div>\\n<style>\\nIMG.center {\\n    display: block;\\n    margin-left: auto;\\n    margin-right: auto }\\n</style>\"\n}\n[/block]\nKeep up to date on all things Cog by following [:::at:::OperableInc](https://twitter.com/operableinc) on Twitter. Also, contact us at anytime via <info@operable.io>.\n\n**Current version:** v0.15.2 ([Changelog](https://github.com/operable/cog/releases))\n**Roadmap:** [2H 2016 Roadmap](https://github.com/operable/cog/milestone/18)\n\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Gradual Depreciation of Content +\",\n  \"body\": \"We are in the process of moving all the Docs to a new and easier repository to handle, The Cog Book. As we move documentation over, we will put this fancy note at the top of the page.\"\n}\n[/block]\n## Get Started\nHere are a few things you will need to do first.\n\n1. Join our [Cog Public Chat](http://slack.operable.io/) to chat with the Operable team and the Cog community. This is the best place to get realtime help.\n2. Head over to the [Installation Guide](doc:installation) and start installing Cog. Have questions? Ask us!\n3. Once installed, make Cog do something. Read up on [Commands and Bundles](doc:commands-and-bundles) \n4. Do you want to expand Cog's command capabilities? Easy, start [Building Command Bundles](doc:building-command-bundles).\n\n## Communication\nLet's set expectations. If you have a question, concern, idea, helpful hint, or want to tell us that you are hungry, we are listening. Please be as candid with us as possible. You can't hurt our feelings...too much. So that we can communicate as easily as possible we have several channels that you can use at anytime.\n\n**GitHub Issues**\nIf you find an issue, please write it up as a [GitHub Issue](https://github.com/operable/cog/issues)\n\n**Cog Public Chat via Slack**\nChat with Operable engineers and the growing community in the [Cog public Slack](http://slack.operable.io) channel.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/V81RY1rTbaHbWMVAWq8s_SlackLogo.png\",\n        \"SlackLogo.png\",\n        \"1152\",\n        \"540\",\n        \"#dd1853\",\n        \"\"\n      ],\n      \"sizing\": \"80\"\n    }\n  ]\n}\n[/block]\n## User experience feedback\nMuch like communication states above, we want to know how your experience is going. Give us feedback, the good/bad/ugly. We want to know everything, so please keep notes (mental/paper/your-favorite-note-taking-app).   \n\n**Some user experience areas we will be asking you about are**:\n\n1. Cog installation\n2. Documentation usage\n3. Bundle installation\n4. Command / bundle creation\n5. Cog use in your Slack channel\n6. Team sharing\n7. What are we missing, not considering?","excerpt":"","slug":"introducing-cog","type":"basic","title":"Introducing Cog"}
[block:image] { "images": [ { "image": [ "https://files.readme.io/a24c657-cog_storywheel1.png", "cog_storywheel1.png", 720, 720, "#111212" ], "caption": "Cog + ChatOps = Continuous DevOps" } ] } [/block] [block:callout] { "type": "danger", "title": "Cog's Docs are moving!", "body": "We are in the process of moving and updating all of the content here SO if you see a Depreciation Note on top of the page, please head over to [The Cog Book](http://cog-book.operable.io).\n\nThanks for your patience!\n\nOperable Team" } [/block] **Cog** brings the power of the command line to the place you collaborate with your team all the time -- your chat window. Powerful access control means you can collaborate around even the most sensitive tasks with confidence. A focus on extensibility and adaptability means that you can respond quickly to the unexpected, without your team losing visibility. [block:image] { "images": [ { "image": [ "https://files.readme.io/cda51f2-cog1.gif", "cog1.gif", 1166, 489, "#d2d2d2" ], "caption": "Cog being used as part of your workflow.", "border": true } ] } [/block] ## Current Features Cog is under heavy development and getting smarter all the time. This list of features gives you an idea of how Cog was built as well as the things that Cog knows how to do. [block:html] { "html": "<div>\n<table>\n <tr>\n <td>\n <img src=\"http://www.operable.io/assets/img/icons/feature_icons_extensibility.png\" class=\"center\">\n <h2 style=\"text-align:center;\">Extensibility</h2>\n <p><ul>\n <li>Build new bot commands in any language</li>\n <li>Commands return structured data to allow for creative adaptation in pipelines</li>\n \t\t\t<li>Built in templating allows the command response to be formatted for the current chat provider without embedding markup in your logic</li>\n </ul></p>\n </td>\n<td>\n <img src=\"http://www.operable.io/assets/img/icons/feature_icons_adaptability.png\" class=\"center\">\n <h2 style=\"text-align:center;\">Adaptability</h2>\n <p><ul>\n <li>Unix-style pipelines allow you to combine a series of simple commands to solve complex, unexpected problems</li>\n <li>Support for output redirection lets you make sure everyone is in the loop</li>\n </ul></p>\n </td>\n</tr>\n <tr>\n <td>\n <img src=\"http://www.operable.io/assets/img/icons/feature_icons_security.png\" class=\"center\">\n <h2 style=\"text-align:center;\">Security</h2>\n <p><ul>\n <li>Fine-grained command permissions give you confidence in using chatops for even the most sensitive workflows</li>\n <li>Users, Groups, and Roles allow you to organize access control for ease of management</li>\n \t\t\t<li>Audit logging for commands and administrative functions let you keep track of everything that happens with Cog</li>\n </ul></p>\n </td>\n<td>\n <img src=\"http://www.operable.io/assets/img/icons/feature_icons_chatagnostic.png\" class=\"center\">\n <h2 style=\"text-align:center;\">Chat-provider agnostic</h2>\n <p><ul>\n <li>Current support for Slack</li>\n <li>HipChat adapter in progress</li>\n \t\t\t\t<li>...other chat clients are on the roadmap!</li>\n </ul></p>\n </td>\n</tr>\n</div>\n<style>\nIMG.center {\n display: block;\n margin-left: auto;\n margin-right: auto }\n</style>" } [/block] Keep up to date on all things Cog by following [@OperableInc](https://twitter.com/operableinc) on Twitter. Also, contact us at anytime via <info@operable.io>. **Current version:** v0.15.2 ([Changelog](https://github.com/operable/cog/releases)) **Roadmap:** [2H 2016 Roadmap](https://github.com/operable/cog/milestone/18) [block:callout] { "type": "warning", "title": "Gradual Depreciation of Content +", "body": "We are in the process of moving all the Docs to a new and easier repository to handle, The Cog Book. As we move documentation over, we will put this fancy note at the top of the page." } [/block] ## Get Started Here are a few things you will need to do first. 1. Join our [Cog Public Chat](http://slack.operable.io/) to chat with the Operable team and the Cog community. This is the best place to get realtime help. 2. Head over to the [Installation Guide](doc:installation) and start installing Cog. Have questions? Ask us! 3. Once installed, make Cog do something. Read up on [Commands and Bundles](doc:commands-and-bundles) 4. Do you want to expand Cog's command capabilities? Easy, start [Building Command Bundles](doc:building-command-bundles). ## Communication Let's set expectations. If you have a question, concern, idea, helpful hint, or want to tell us that you are hungry, we are listening. Please be as candid with us as possible. You can't hurt our feelings...too much. So that we can communicate as easily as possible we have several channels that you can use at anytime. **GitHub Issues** If you find an issue, please write it up as a [GitHub Issue](https://github.com/operable/cog/issues) **Cog Public Chat via Slack** Chat with Operable engineers and the growing community in the [Cog public Slack](http://slack.operable.io) channel. [block:image] { "images": [ { "image": [ "https://files.readme.io/V81RY1rTbaHbWMVAWq8s_SlackLogo.png", "SlackLogo.png", "1152", "540", "#dd1853", "" ], "sizing": "80" } ] } [/block] ## User experience feedback Much like communication states above, we want to know how your experience is going. Give us feedback, the good/bad/ugly. We want to know everything, so please keep notes (mental/paper/your-favorite-note-taking-app). **Some user experience areas we will be asking you about are**: 1. Cog installation 2. Documentation usage 3. Bundle installation 4. Command / bundle creation 5. Cog use in your Slack channel 6. Team sharing 7. What are we missing, not considering?