Skip to content

Commit 872826c

Browse files
authored
Merge pull request Yelp#2419 from abhishekjiitr/patch-6
Fix Running ElastAlert Instructions in README
2 parents 9629a65 + d75a07f commit 872826c

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,23 @@ In addition to this basic usage, there are many other features that make alerts
7171
To get started, check out `Running ElastAlert For The First Time` in the [documentation](http://elastalert.readthedocs.org).
7272

7373
## Running ElastAlert
74+
You can either install the latest released version of ElastAlert using pip:
7475

75-
``$ python elastalert/elastalert.py [--debug] [--verbose] [--start <timestamp>] [--end <timestamp>] [--rule <filename.yaml>] [--config <filename.yaml>]``
76+
```pip install elastalert```
77+
78+
or you can clone the ElastAlert repository for the most recent changes:
79+
80+
```git clone https://github.com/Yelp/elastalert.git```
81+
82+
Install the module:
83+
84+
```pip install "setuptools>=11.3"```
85+
86+
```python setup.py install```
87+
88+
The following invocation can be used to run ElastAlert after installing
89+
90+
``$ elastalert [--debug] [--verbose] [--start <timestamp>] [--end <timestamp>] [--rule <filename.yaml>] [--config <filename.yaml>]``
7691

7792
``--debug`` will print additional information to the screen as well as suppresses alerts and instead prints the alert body. Not compatible with `--verbose`.
7893

0 commit comments

Comments
 (0)