Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/linjunpop/imessage

💬 Send iMessages from command-line
https://github.com/linjunpop/imessage

cli command-line imessage macos osx

Last synced: 4 days ago
JSON representation

💬 Send iMessages from command-line

Awesome Lists containing this project

README

        

# imessage

Command line tool to send iMessage.

![Tests](https://github.com/linjunpop/imessage/actions/workflows/test.yml/badge.svg)
[![Gem Version](https://img.shields.io/gem/v/imessage.svg)](https://rubygems.org/gems/imessage)
[![codebeat badge](https://codebeat.co/badges/69f6f8ee-8ddd-4355-aa7c-0cd4ac369718)](https://codebeat.co/projects/github-com-linjunpop-imessage-master)

## Installation

### As a Homebrew(http://brew.sh) package

$ brew install imessage-ruby

### As a gem

Add this line to your application's Gemfile:

gem 'imessage'

And then execute:

$ bundle

Or install it yourself as:

$ gem install imessage

## Usage

```shell
Usage: imessage [options]

Specific options:
-t, --text [TEXT] The TEXT to deliver
-a, --attachment [ATTACHMENT] Add an attachment
-c, --contacts x,y,z Deliver message to these CONTACTS

Common options:
-h, --help Prints this help
--version Show version
```

## Example

```
$ imessage --text "hello" --contacts "[email protected]" --attachment 'bar.png'
```

## [Changelog](CHANGELOG.md)

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/linjunpop/imessage.