cleentfaar/slack-cli

Command-line application for interacting with the Slack API.

Slack CLI

Command-line application for interacting with the Slack API library. Provides CLI commands for all of the API methods currently available using a single phar executable., _(*1)

, _(*2)

Quick look

Sending a message to a Slack channel (in this case '#general'), _(*3)

$ slack.phar chat:post-message general "Hello world!"

Update the application, _(*4)

slack.phar self:update

Check out the documentation below for more examples and instructions on how to install the .phar file., _(*5)

Installation / Usage

1. Download the slack.phar executable or use the installer., _(*6)

   sh $ curl -sS http://cleentfaar.github.io/slack-cli/installer | php, _(*7)

2. Run Slack CLI: php slack.phar, _(*8)

Installation from Source

To run tests, or develop Slack CLI itself, you must use the sources and not the phar file as described above. Before continuing, you should also install Composer either globally or in the cloned repository below., _(*9)

1. Run git clone https://github.com/cleentfaar/slack-cli.git
2. Run Composer to get the dependencies: cd slack-cli && composer install

You can now run Slack CLI by executing the ./slack script: php ./slack, _(*10)

Global installation (manual)

Follow instructions in the documentation, _(*11)

Documentation

• Installation - Information on installing this package either globally or as a composer dependency.
• Usage - A few simple examples on how to use some of the console commands provided by this package.

Detailed documentation

This package only provides a command-line interface to access the Slack API methods; if you want to get your hands dirty on how to use the payloads and responses in your own application, check out the library that this package implements: Slack API library., _(*12)

Contributing

Got a good idea for this project? Found a nasty bug that needs fixing? That's great! Before submitting your PR however, make sure it complies with the contributing guide to speed up the merging of your code., _(*13)

Related packages

• Slack - Main library package consisting of the API client and model classes that adhere to the Slack API specs.
• SlackBundle - Symfony Bundle providing integration with the Slack API library above.

Attributions

• The Slack staff, for making a great product and very clean API documentation.
• MattKetmo, for his very useful article on distributing CLI applications and his bump-version.sh script.
• Composer, for a shameless copy of their installer script and relevant documentation.