{"id":22147259,"url":"https://github.com/centerforopenscience/hubot","last_synced_at":"2025-08-20T20:16:00.063Z","repository":{"id":136988397,"uuid":"114006969","full_name":"CenterForOpenScience/hubot","owner":"CenterForOpenScience","description":"A robot for chat ops","archived":false,"fork":false,"pushed_at":"2018-01-30T19:56:35.000Z","size":22,"stargazers_count":4,"open_issues_count":0,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-21T22:39:15.100Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CenterForOpenScience.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-12-12T15:30:36.000Z","updated_at":"2020-06-25T22:47:55.000Z","dependencies_parsed_at":null,"dependency_job_id":"5843000f-0de0-433c-b801-8c168e581fb6","html_url":"https://github.com/CenterForOpenScience/hubot","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CenterForOpenScience%2Fhubot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CenterForOpenScience%2Fhubot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CenterForOpenScience%2Fhubot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CenterForOpenScience%2Fhubot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CenterForOpenScience","download_url":"https://codeload.github.com/CenterForOpenScience/hubot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248226415,"owners_count":21068200,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-01T23:15:39.582Z","updated_at":"2025-04-10T13:43:56.618Z","avatar_url":"https://github.com/CenterForOpenScience.png","language":null,"readme":"# hubot\n\nhubot is a chat bot built on the [Hubot][hubot] framework. It was\ninitially generated by [generator-hubot][generator-hubot], and configured to be\ndeployed with [Docker][docker] to get you up and running as quick as possible.\n\nThis README is intended to help get you started. Definitely update and improve\nto talk about your own instance, how to use and deploy, what functionality is\navailable, etc!\n\n[docker]: http://www.docker.com\n[hubot]: http://hubot.github.com\n[generator-hubot]: https://github.com/github/generator-hubot\n\n### Running hubot Locally\n\nYou can test your hubot by running the following, however some plugins will not\nbehave as expected unless the [environment variables](#configuration) they rely\nupon have been set.\n\nYou can start hubot locally by running:\n\n```bash\nyarn --frozen-lockfile\nyarn start\n```\n\nYou'll see some start up output and a prompt:\n\n    [Sat Feb 28 2015 12:38:27 GMT+0000 (GMT)] INFO Using default redis on localhost:6379\n    hubot\u003e\n\nThen you can interact with hubot by typing `hubot help`.\n\n    hubot\u003e hubot help\n    hubot animate me \u003cquery\u003e - The same thing as `image me`, except adds [snip]\n    hubot help - Displays all of the help commands that hubot knows about.\n    ...\n\n### Configuration\n\nA few scripts (including some installed by default) require environment\nvariables to be set as a simple form of configuration.\n\n#### Example .docker-compose.env\n\n```bash\nHUBOT_ADAPTER=flowdock\nHUBOT_FLOWDOCK_API_TOKEN=aaaa1111bbbb2222cccc3333dddd4444\nHUBOT_LOG_LEVEL=debug\n```\n\n### Scripting\n\nTo get started, along with the [Scripting Guide][scripting-docs].\n\nFor many common tasks, there's a good chance someone has already one to do just\nthe thing.\n\n[scripting-docs]: https://github.com/github/hubot/blob/master/docs/scripting.md\n\n### external-scripts\n\nThere will inevitably be functionality that everyone will want. Instead of\nwriting it yourself, you can use existing plugins.\n\nHubot is able to load plugins from third-party `yarn` packages. This is the\nrecommended way to add functionality to your hubot. You can get a list of\navailable hubot plugins on [yarnpkg.com][yarn] or by using `npm search`:\n\n```bash\n$ npm search hubot-scripts panda\nNAME             DESCRIPTION                        AUTHOR DATE       VERSION KEYWORDS\nhubot-pandapanda a hubot script for panda responses =missu 2014-11-30 0.9.2   hubot hubot-scripts panda\n...\n```\n\nTo use a package, check the package's documentation, but in general it is:\n\n1. Use `yarn add` to add the package to `package.json` and install it\n2. Add the package name to `external-scripts.json` as a double quoted string\n\nYou can review `external-scripts.json` to see what is included by default.\n\n##### Advanced Usage\n\nIt is also possible to define `external-scripts.json` as an object to\nexplicitly specify which scripts from a package should be included. The example\nbelow, for example, will only activate two of the six available scripts inside\nthe `hubot-fun` plugin, but all four of those in `hubot-auto-deploy`.\n\n```json\n{\n  \"hubot-fun\": [\n    \"crazy\",\n    \"thanks\"\n  ],\n  \"hubot-auto-deploy\": \"*\"\n}\n```\n\n**Be aware that not all plugins support this usage and will typically fallback\nto including all scripts.**\n\n[yarn]: https://www.yarnpkg.com\n\n### hubot-scripts\n\nBefore hubot plugin packages were adopted, most plugins were held in the\n[hubot-scripts][hubot-scripts] package. Some of these plugins have yet to be\nmigrated to their own packages. They can still be used but the setup is a bit\ndifferent.\n\nTo enable scripts from the hubot-scripts package, add the script name with\nextension as a double quoted string to the `hubot-scripts.json` file in this\nrepo.\n\n[hubot-scripts]: https://github.com/github/hubot-scripts\n\n## Persistence\n\nThis configuration uses `hubot-redis-brain`.\n\n## Adapters\n\nAdapters are the interface to the service you want your hubot to run on, such\nas Campfire or IRC. There are a number of third party adapters that the\ncommunity have contributed. Check [Hubot Adapters][hubot-adapters] for the\navailable ones.\n\nIf you would like to run a non-Campfire or shell adapter you will need to add\nthe adapter package as a dependency to the `package.json` file in the\n`dependencies` section.\n\nOnce you've added the dependency with `yarn add` to install it you\ncan then run hubot with the adapter.\n\n```bash\nHUBOT_ADAPTER=\u003cadapter\u003e yarn start\n```\n\nWhere `\u003cadapter\u003e` is the name of your adapter without the `hubot-` prefix.\n\n[hubot-adapters]: https://github.com/github/hubot/blob/master/docs/adapters.md\n\n## Deployment\n\n```bash\ndocker-compose pull\ndocker-compose build\ndocker-compose up\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcenterforopenscience%2Fhubot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcenterforopenscience%2Fhubot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcenterforopenscience%2Fhubot/lists"}