alexdavid / sigma

A stable Golang API for iMessage on MacOS

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

sigma

A stable Golang API for MacOS Messages app.

GoDoc


I built sigma mostly for myself to be able to send and receive messages from Linux. It is purely a Go library to abstract any future breakages Apple might make and provide a simple and consistent API.

Usage

Sigma by itself is probably not very useful to you unless you want to build your own frontend. Instead, see one of the pre-built frontends:

  • Sigma-Web
  • Sigma-matrix (I'll get around to building this one day)

To write your own frontend see GoDoc here. Note: Sigma is still in very early development and the API may change, but probably won't.

Requirements

The sigma package requires an Apple computer running MacOS 10.12 or later with Messages signed into an iMessage account to work.

If you want to develop a frontend without this requirement you can use the mock.NewClient which returns the same Client interface that sigma.NewClient returns.

Alternatives

Todo

  • Look into better display name handling if a contact exists in address book
  • Create matrix bridge

About

A stable Golang API for iMessage on MacOS

License:MIT License


Languages

Language:Go 100.0%