{"id":24514637,"url":"https://github.com/wechaty/puppet-gitter","last_synced_at":"2026-04-17T08:31:15.406Z","repository":{"id":47404309,"uuid":"289195548","full_name":"wechaty/puppet-gitter","owner":"wechaty","description":"Gitter.im Puppet for Wechaty ","archived":false,"fork":false,"pushed_at":"2023-01-16T05:29:54.000Z","size":249,"stargazers_count":1,"open_issues_count":6,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-01-20T10:55:54.014Z","etag":null,"topics":["gitter","puppet","wechaty"],"latest_commit_sha":null,"homepage":"https://npmjs.com/package/wechaty-puppet-gitter","language":"TypeScript","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/wechaty.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}},"created_at":"2020-08-21T06:30:26.000Z","updated_at":"2021-11-21T17:23:13.000Z","dependencies_parsed_at":"2023-02-10T01:16:42.122Z","dependency_job_id":null,"html_url":"https://github.com/wechaty/puppet-gitter","commit_stats":null,"previous_names":["wechaty/wechaty-puppet-gitter"],"tags_count":0,"template":false,"template_full_name":"wechaty/puppet-mock","purl":"pkg:github/wechaty/puppet-gitter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fpuppet-gitter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fpuppet-gitter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fpuppet-gitter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fpuppet-gitter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wechaty","download_url":"https://codeload.github.com/wechaty/puppet-gitter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fpuppet-gitter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31921754,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-16T18:22:33.417Z","status":"online","status_checked_at":"2026-04-17T02:00:06.879Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["gitter","puppet","wechaty"],"created_at":"2025-01-22T01:13:57.384Z","updated_at":"2026-04-17T08:31:15.384Z","avatar_url":"https://github.com/wechaty.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Wechaty Puppet Gitter\n\n[![NPM Version](https://badge.fury.io/js/wechaty-puppet-gitter.svg)](https://badge.fury.io/js/wechaty-puppet-gitter)\n[![npm (tag)](https://img.shields.io/npm/v/wechaty-puppet-gitter/next.svg)](https://www.npmjs.com/package/wechaty-puppet-gitter?activeTab=versions)\n[![NPM](https://github.com/wechaty/wechaty-puppet-gitter/workflows/NPM/badge.svg)](https://github.com/wechaty/wechaty-puppet-gitter/actions?query=workflow%3ANPM)\n[![ES Modules](https://img.shields.io/badge/ES-Modules-brightgreen)](https://github.com/Chatie/tsconfig/issues/16)\n\n![wechaty puppet gitter](docs/images/wechaty-puppet-gitter.png)\n\n[![Powered by Wechaty](https://img.shields.io/badge/Powered%20By-Wechaty-brightgreen.svg)](https://github.com/wechaty/wechaty)\n[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-blue.svg)](https://www.typescriptlang.org/)\n[![Gitter](https://badges.gitter.im/wechaty/wechaty.svg)](https://gitter.im/wechaty/wechaty?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge)\n\n\u003e Gitter is an open-source instant messaging and chat room system for developers and users of GitLab and GitHub repositories.  \n\u003e \u0026dash; [WikiPedia](https://en.wikipedia.org/wiki/Gitter)\n\nWechaty Puppet for  Gitter: \u003chttps://gitter.im\u003e\n\n## Feature\n\n1. Receive and send text messages in Gitter.im rooms.\n\n## USAGE\n\nThe `wechaty-puppet-gitter` needs a TOKEN and only one token from gitter so that it can connect to the gitter.im service.\n\n\u003e Learn more about the TOKEN from gitter.im at \u003chttps://developer.gitter.im/apps\u003e\n\nYou can pass the token to this puppet by putting it into `options`, or by setting the environment variable `WECHATY_PUPPET_GITTER_TOKEN`.\n\n### Puppet Gitter\n\n```ts\nimport { Wechaty }   from 'wechaty'\nimport { PuppetGitter } from 'wechaty-puppet-gitter'\n\n/**\n * Personal Access Token: this token can be used to access the Gitter API.\n *  https://developer.gitter.im/apps\n */\nconst puppet  = new PuppetGitter({ token: 'your_gitter_token' })\nconst wechaty = new Wechaty({ puppet })\n\nawait wechaty.start()\n```\n\n### Environment Variable: `WECHATY_PUPPET_GITTER_TOKEN`\n\nThe `wechaty-puppet-gitter` will search the environment variable named `WECHATY_PUPPET_GITTER_TOKEN` to get the token if you do not set it in the `options`.\n\n## Resources\n\n1. [Gitter.im Developer Documents](https://developer.gitter.im/docs/welcome)\n\n### GitHub Projects\n\n1. [IRC ⚡ Gitter, https://irc.gitter.im](https://gitlab.com/gitlab-org/gitter/irc-bridge)\n1. [Bot that synchronises messages from gitter and irc](https://github.com/finnp/gitter-irc-bot)\n1. [Add a Integration feature for IRC (two-way sync between gitter room and a designated IRC channel)](https://gitlab.com/gitlab-org/gitter/webapp/-/issues/662)\n1. [Slack API: Enabling interactions with bots](https://api.slack.com/bot-users)\n1. [Matrix \u003c-\u003e Gitter bridge](https://github.com/matrix-org/matrix-appservice-gitter)\n\n## HISTORY\n\n### master v1.0 Release\n\nRelease v1.0\n\n1. v0.7 (Oct 2021): Upgrade to Puppet v0.51 API\n1. v0.5 (Sep 2021): ES Modules support\n\n### v0.4 (Aug 27, 2020)\n\n1. Support send/receive image ([#2](https://github.com/wechaty/wechaty-puppet-gitter/issues/2))\n\n### v0.2 (Aug 21, 2020)\n\nInitial version.\n\n`PuppetGitter` is a Gitter Puppet for \u003chttps://gitter.im\u003e\n\n## AUTHOR\n\n[Huan LI](http://linkedin.com/in/zixia) \\\u003czixia@zixia.net\\\u003e\n\n\u003c!-- markdownlint-disable MD033 --\u003e\n\u003ca href=\"https://stackexchange.com/users/265499\"\u003e\n  \u003cimg src=\"https://stackexchange.com/users/flair/265499.png\" width=\"208\" height=\"58\" alt=\"profile for zixia on Stack Exchange, a network of free, community-driven Q\u0026amp;A sites\" title=\"profile for zixia on Stack Exchange, a network of free, community-driven Q\u0026amp;A sites\"\u003e\n\u003c/a\u003e\n\n## COPYRIGHT \u0026 LICENSE\n\n* Code \u0026 Docs © 2020-now Huan LI \\\u003czixia@zixia.net\\\u003e\n* Code released under the Apache-2.0 License\n* Docs released under Creative Commons\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwechaty%2Fpuppet-gitter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwechaty%2Fpuppet-gitter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwechaty%2Fpuppet-gitter/lists"}