2017 © Pedro Peláez
 

library slack-cron

Execute a command and send errors or output to slack (usefull for cron jobs).

image

qtsd/slack-cron

Execute a command and send errors or output to slack (usefull for cron jobs).

  • Wednesday, May 31, 2017
  • by qtsd
  • Repository
  • 1 Watchers
  • 0 Stars
  • 13 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 1 Versions
  • 0 % Grown

The README.md

Introduction

A simple tool writen in PHP using some symfony components.
Used to execute a command and send errors or output to slack using Incoming Webhooks (usefull for cron jobs)., (*1)

Requirements

  • PHP 5.6 and up.
  • cURL accessible from path.
  • composer to install dependencies.

Installation

Via composer ``` sh $ composer create-project qtsd/slack-cron slack-cron dev-master --keep-vcs, (*2)


From sources
``` sh
$ git clone git@github.com:qtsd/slack-cron.git
$ composer install -d slack-cron

Configuration

Path
You can link the app to the path to use it from everywhere.
The symlink should conventionally be on /usr/local/bin, but cron path do not include it, so use /usr/bin instead. ``` sh $ sudo ln -s pwd/slack-cron/bin/console /usr/bin/slack-cron, (*3)


**Slack**  
Slack webhook url is asked on *composer install*, and will be kept in *conf/parameters.yml*.  
To get a webhook url, go on Slack > [Getting started with custom integrations](https://api.slack.com/custom-integrations) > New webhook.


Documentation
-------------
**Usage**  
run [options] \<exec\> [\<path\>]  

**Arguments**  
* **exec**  *The command to execute.*  
* **path**   *The working directory.*

**Options**
*  **--timeout[=TIMEOUT]**  *Command timeout in seconds [default: 120]*
* **--output-all** *Send all output to slack (not just errors)*

Examples
-------------
Call from path
``` sh
$ slack-cron run [...]

Call from install directory ``` sh $ bin/console run [...], (*4)

List files of the current directory, and send output to slack
``` sh
$ slack-cron run 'ls -al' --output-all

Try to create a file /foo.txt, and send output to slack if encounter an error sh $ slack-cron run 'touch foo' /, (*5)

License

Licensed under the MIT license: http://www.opensource.org/licenses/mit-license.php, (*6)

The Versions

31/05 2017

dev-master

9999999-dev https://github.com/qtsd/slack-cron

Execute a command and send errors or output to slack (usefull for cron jobs).

  Sources   Download

MIT

The Requires