{"id":38146009,"url":"https://github.com/gottaeat/bands","last_synced_at":"2026-01-16T22:56:01.796Z","repository":{"id":183582532,"uuid":"667852550","full_name":"gottaeat/bands","owner":"gottaeat","description":"RFC 1459 and 2812 compliant (with a bit of IRCv3), concurrent IRC bot with extensive and extendable features.","archived":false,"fork":false,"pushed_at":"2025-12-15T00:20:42.000Z","size":862,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-12-17T14:54:32.609Z","etag":null,"topics":["irc","irc-bot","irc-client","python-bot"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gottaeat.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-07-18T12:55:08.000Z","updated_at":"2025-12-15T00:20:00.000Z","dependencies_parsed_at":"2023-10-24T05:22:17.129Z","dependency_job_id":"87cb017b-c22f-45d3-a590-3b52a3a6adc1","html_url":"https://github.com/gottaeat/bands","commit_stats":null,"previous_names":["gottaeat/shart","gottaeat/bands","gottaeat/barrel"],"tags_count":22,"template":false,"template_full_name":null,"purl":"pkg:github/gottaeat/bands","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gottaeat%2Fbands","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gottaeat%2Fbands/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gottaeat%2Fbands/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gottaeat%2Fbands/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gottaeat","download_url":"https://codeload.github.com/gottaeat/bands/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gottaeat%2Fbands/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28486939,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T22:54:02.790Z","status":"ssl_error","status_checked_at":"2026-01-16T22:50:10.344Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["irc","irc-bot","irc-client","python-bot"],"created_at":"2026-01-16T22:56:01.733Z","updated_at":"2026-01-16T22:56:01.785Z","avatar_url":"https://github.com/gottaeat.png","language":"Python","readme":"# bands\nbands is an internet relay chat bot.\n\n## features\n- covers all relevant portions of rfc's 1459 and 2812.\n- ircv3 caps supported are `chghost` and `multi-prefix`.\n- concurrent multi-server and multi-channel support.\n- awareness of the channel, channel user, server and server user contexts.\n- full state maniuplation and hot config reload through private messages on\n  trusted servers.\n\nand many more\n\n## installation\n### 1. stable\n```sh\n# 1. get the compose file\nmkdir bands/; cd bands/\ncurl -LO \\\n    https://raw.githubusercontent.com/gottaeat/bands/master/docker-compose.yml\n\n# 2. create the volume mount\nmkdir data/; cd data/\n\n# 3. create a config.yml within this directory following the spec and the\n#    example below\n\n# 4. compose up\ncd ../\ndocker compose up -d\n```\n\n### 2. dev\n```sh\n# 1. clone the repo\ngit clone --depth=1 https://github.com/gottaeat/bands\ncd bands/\n\n# 2. uncomment the `build' key and comment out the `image' key inside\n#    docker-compose.yml to build the image instead of using the one from ghcr\n\n# 3. create the volume mount\nmkdir data/; cd data/\n\n# 4. create a config.yml within this directory following the spec and the\n#    example below\n\n# 5. compose up\ncd ../;\ndocker compose up -d\n```\n\n## configuration\n### specification\n#### root\n| key               | necessity     | description                                               |\n|-------------------|---------------|-----------------------------------------------------------|\n| `wolfram_api_key` | optional      | (`str`) wolfram alpha api key for module support          |\n| `openai`          | optional      | root key for the openai-related configuration             |\n| `piped_url`       | optional      | (`str`) fqdn to make piped api requests to [1]            |\n| `quote_file`      | optional      | (`str`) path to read/write channel quotes to and from [2] |\n| `doot_file`       | optional      | (`str`) path to read/write server points to and from [2]  |\n| `servers`         | __required__  | list of servers to connect to on startup                  |\n\n__[1]__ if none specified, will fall back to a default that may or may not be\navailable to make api calls to.\n\n__[2]__ `quote_file` and `doot_file` keys, if not specified, will default to\n`/data/quotes.json` and `/data/doots.json` respectively. regardless of the\nvalues being specified, if they do not exist, bands will attempt to create and\ninitialize the files.\n\n#### openai\n| key     | necessity    | description                                        |\n|---------|--------------|----------------------------------------------------|\n| `key`   | __required__ | (`str`) openai api key for module support          |\n| `model` | __required__ | (`str`) openai model name to be used in modules[1] |\n\n__[1]__ model names are sanity checked against a list of text-only openai\nmodels, to see the complete list, just bring up the bot with a random value for\nthe `model` key.\n\n#### servers\n| key            | necessity                    | description                                                                      |\n|----------------|------------------------------|----------------------------------------------------------------------------------|\n| `name`         | __required__                 | (`str`) reference name for the network                                           |\n| `address`      | __required__                 | (`str`) network address                                                          |\n| `port`         | __required__                 | (`int`) network port                                                             |\n| `passwd`       | optional                     | (`str`) network password                                                         |\n| `botname`      | __required__                 | (`str`) bot nick+ident                                                           |\n| `tls`          | optional                     | (`bool`) enable tls, false by default                                            |\n| `verify_tls`   | optional                     | (`bool`) verify tls, false by default                                            |\n| `scroll_speed` | required __if burst_speed__  | (`int`) how long the wait before sending multiple lines (fakelag)                |\n| `burst_speed`  | required __if scroll_speed__ | (`int`) amount of messages allowed before scroll_speed sleep timer kicks in      |\n| `channels`     | __required__                 | (`list of str's`) channel list to autojoin on startup                            |\n| `allow_admin`  | optional                     | (`bool`) allow authentication and remote control on the server, false by default |\n| `secret`       | required __if allow_admin__  | (`str`) authentication secret                                                    |\n\n### example\n```yml\nwolfram_api_key: \"XXXXX-XXXXXXXXXX\"\npiped_url: \"pipedapi.myfavinstance.net\"\nopenai:\n    key: \"sk-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\"\n    model: 'gpt-4o-mini'\n\nservers:\n  - name: privnet\n    address: irc.cooldomain.to\n    port: 6697\n    passwd: topsekrit\n    botname: bands\n    tls: true\n    channels:\n      - \"#mychannel\"\n      - \"#mychannel2\"\n    allow_admin: true\n    secret: EsDf/ZcdNp1whuZh\n  - name: publicnet\n    address: irc.example.com\n    port: 6697\n    botname: stacks\n    tls: true\n    verify_tls: true\n    scroll_speed: 1\n    burst_limit: 2\n    channels:\n      - \"#pubchannel\"\n```\n\n## usage\nfor user-accesible features, call `?help` in either the context of a channel or\na private message with the bot.\n\ncmdline specific usage is:\n```sh\nusage: bands [-h] -c C [-d]\n\nbands the irc bot ver. \u003cversion\u003e\n\noptions:\n  -h, --help  show this help message and exit\n  -c C        path to config yaml\n  -d          enable debug\n```\n\n## management\n1. set at least one of the servers to have `allow_admin` and a `secret`.\n2. privmsg the `botname` with `?auth $secret`.\n3. call `?rcon help` for a list of management related functionality.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgottaeat%2Fbands","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgottaeat%2Fbands","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgottaeat%2Fbands/lists"}