{"id":18841591,"url":"https://github.com/subvisual/gbot","last_synced_at":"2026-01-30T12:30:12.528Z","repository":{"id":29941963,"uuid":"33488326","full_name":"subvisual/gbot","owner":"subvisual","description":null,"archived":false,"fork":false,"pushed_at":"2015-10-27T11:43:13.000Z","size":316,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-12-30T10:44:17.354Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/subvisual.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-04-06T15:12:02.000Z","updated_at":"2020-06-24T22:35:23.000Z","dependencies_parsed_at":"2022-08-18T00:35:31.002Z","dependency_job_id":null,"html_url":"https://github.com/subvisual/gbot","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/subvisual%2Fgbot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/subvisual%2Fgbot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/subvisual%2Fgbot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/subvisual%2Fgbot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/subvisual","download_url":"https://codeload.github.com/subvisual/gbot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239780122,"owners_count":19695734,"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-11-08T02:51:49.989Z","updated_at":"2025-02-20T04:42:18.567Z","avatar_url":"https://github.com/subvisual.png","language":"JavaScript","readme":"# gbot\n\ngbot is a chat bot built on the [Hubot][hubot] framework. It was\ninitially generated by [generator-hubot][generator-hubot].\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 he\nhas, etc!\n\n[hubot]: http://hubot.github.com\n[generator-hubot]: https://github.com/github/generator-hubot\n\n### Running gbot 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 gbot locally by running:\n\n    % bin/hubot\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    gbot\u003e\n\nThen you can interact with gbot by typing `gbot help`.\n\n    gbot\u003e gbot help\n    gbot animate me \u003cquery\u003e - The same thing as `image me`, except adds [snip]\n    gbot help - Displays all of the help commands that gbot 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\nEach script should have a commented header which contains a \"Configuration\"\nsection that explains which values it requires to be placed in which variable.\nWhen you have lots of scripts installed this process can be quite labour\nintensive. The following shell command can be used as a stop gap until an\neasier way to do this has been implemented.\n\n    grep -o 'hubot-[a-z0-9_-]\\+' external-scripts.json | \\\n      xargs -n1 -i sh -c 'sed -n \"/^# Configuration/,/^#$/ s/^/{} /p\" \\\n          $(find node_modules/{}/ -name \"*.coffee\")' | \\\n        awk -F '#' '{ printf \"%-25s %s\\n\", $1, $2 }'\n\nHow to set environment variables will be specific to your operating system.\nRather than recreate the various methods and best practices in achieving this,\nit's suggested that you search for a dedicated guide focused on your OS.\n\n### Scripting\n\nAn example script is included at `scripts/example.coffee`, so check it out to\nget 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 `npm` packages. This is the\nrecommended way to add functionality to your hubot. You can get a list of\navailable hubot plugins on [npmjs.com](npmjs) or by using `npm search`:\n\n    % npm search hubot-scripts panda\n    NAME             DESCRIPTION                        AUTHOR DATE       VERSION KEYWORDS\n    hubot-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 `npm install --save` 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[npmjs]: https://www.npmjs.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\nIf you are going to use the `hubot-redis-brain` package (strongly suggested),\nyou will need to add the Redis to Go addon on Heroku which requires a verified\naccount or you can create an account at [Redis to Go][redistogo] and manually\nset the `REDISTOGO_URL` variable.\n\n    % heroku config:add REDISTOGO_URL=\"...\"\n\nIf you don't need any persistence feel free to remove the `hubot-redis-brain`\nfrom `external-scripts.json` and you don't need to worry about redis at all.\n\n[redistogo]: https://redistogo.com/\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 `npm install --save` to install it you\ncan then run hubot with the adapter.\n\n    % bin/hubot -a \u003cadapter\u003e\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    % bundle exec cap production deploy\n\nYou'll need to edit the `Procfile` to set the name of your hubot.\n\n### Deploying to UNIX or Windows\n\nIf you would like to deploy to either a UNIX operating system or Windows.\nPlease check out the [deploying hubot onto UNIX][deploy-unix] and [deploying\nhubot onto Windows][deploy-windows] wiki pages.\n\n[heroku-node-docs]: http://devcenter.heroku.com/articles/node-js\n[deploy-heroku]: https://github.com/github/hubot/blob/master/docs/deploying/heroku.md\n[deploy-unix]: https://github.com/github/hubot/blob/master/docs/deploying/unix.md\n[deploy-windows]: https://github.com/github/hubot/blob/master/docs/deploying/unix.md\n\n## Campfire Variables\n\nIf you are using the Campfire adapter you will need to set some environment\nvariables. If not, refer to your adapter documentation for how to configure it,\nlinks to the adapters can be found on [Hubot Adapters][hubot-adapters].\n\nCreate a separate Campfire user for your bot and get their token from the web\nUI.\n\n    % heroku config:add HUBOT_CAMPFIRE_TOKEN=\"...\"\n\nGet the numeric IDs of the rooms you want the bot to join, comma delimited. If\nyou want the bot to connect to `https://mysubdomain.campfirenow.com/room/42`\nand `https://mysubdomain.campfirenow.com/room/1024` then you'd add it like\nthis:\n\n    % heroku config:add HUBOT_CAMPFIRE_ROOMS=\"42,1024\"\n\nAdd the subdomain hubot should connect to. If you web URL looks like\n`http://mysubdomain.campfirenow.com` then you'd add it like this:\n\n    % heroku config:add HUBOT_CAMPFIRE_ACCOUNT=\"mysubdomain\"\n\n[hubot-adapters]: https://github.com/github/hubot/blob/master/docs/adapters.md\n\n## Restart the bot\n\nYou may want to get comfortable with `heroku logs` and `heroku restart` if\nyou're having issues.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsubvisual%2Fgbot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsubvisual%2Fgbot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsubvisual%2Fgbot/lists"}