Skip to content

Commit

Permalink
Add cli document.
Browse files Browse the repository at this point in the history
  • Loading branch information
heavenshell committed Mar 8, 2015
1 parent e03a369 commit 6edf6cf
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -112,3 +112,38 @@ Post service metrics
# Post 'custom.metrics.latency' and 'custom.metrics.uptime' to `service_name`.
self.client.post_service_metrics('service_name', metrics)
CLI
---

Get host(s) information from hostname or service, role.

.. code:: shell
$ mkr.py info [--name foo] [--service service] [--role role]
Set status of a host.

.. code:: shell
$ mkr.py status --host-id foo --status working
Retire a host.

.. code:: shell
$ mkr.py retire --host-id foo
Get status of a host.

.. code:: shell
$ mkr.py status --host-id foo
Authentication
--------------

.. code:: shell
$ export MACKEREL_APIKEY=foobar

0 comments on commit 6edf6cf

Please sign in to comment.