cleentfaar / slack-cli
Command-line application for interacting with the Slack API.
Requires
- php: >=5.5
- cleentfaar/slack: ~0.20
- composer/composer: ^1.0
- herrera-io/phar-update: ^2.0
- symfony/console: ^2.6|^3.0
Requires (Dev)
- phpunit/phpunit: ^4.5|^5.0
README
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.
Quick look
Sending a message to a Slack channel (in this case '#general')
$ slack.phar chat:post-message general "Hello world!"
Update the application
slack.phar self:update
Check out the documentation below for more examples and instructions on how to install the .phar
file.
Installation / Usage
-
Download the
slack.phar
executable or use the installer.$ curl -sS http://cleentfaar.github.io/slack-cli/installer | php
-
Run Slack CLI:
php slack.phar
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.
- Run
git clone https://github.com/cleentfaar/slack-cli.git
- Run Composer to get the dependencies:
cd slack-cli && composer install
You can now run Slack CLI by executing the ./slack
script: php ./slack
Global installation (manual)
Follow instructions in the documentation
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.
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.
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.