Giter VIP home page Giter VIP logo

go-signal-bot's Introduction

go-signal-bot

go-signal-bot is a bot written in the Go programming language. It is designed to interact with Signal, the secure and privacy-focused messaging platform. It uses OpenAI's GPT4 or GPT3.5's API to respond meaningfully to any messages that contain the bot's name. It can be added to group chats like Meta AI to function like an AI assistant.

Getting Started

Prerequisites

Before you begin, ensure you have met the following requirements:

  • Go1.20
  • signal-cli installed and able to run
  • go-chatgpt
  • You have a separate signal account with a different number for the bot
  • I used the paid version of TextNow, an Android app, to register with Signal
  • OpenAI API key

Installation

  1. Clone the repository:
cd go-signal-bot
  1. Edit config.yml with necessary configurations
  2. Run go run main.go to start the listener

Contributing

Fork it! Please feel free to contribute and create a pull request.

Roadmap

  • improve coverage
  • improve API with additional functionality offered by CLI
  • improve documentation

Contact

Skanda Kaashyap (skandakk [ 4t ] gmail [ dot ] com)

Acknowledgements

Thanks a great deal to the following projects and their maintainers:

  1. signal-cli
  2. go-chatgpt
  3. OpenAI GPTs
  4. Signal and the Signal Foundation

License

Copyright <2024>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

go-signal-bot's People

Contributors

kaashmonee avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Forkers

vecna-signal

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.