You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/rootlyhq/cli">
7
24
<img alt="GitHub go.mod Go version" src="https://img.shields.io/github/go-mod/go-version/rootlyhq/cli">
@@ -18,31 +35,31 @@
18
35
19
36
<hr />
20
37
21
-
-[👋 Getting Started](#-getting-started)
22
-
-[🚀 Install](#-install)
23
-
-[🍎 macOS](#-macos)
24
-
-[🐧 Linux and 🖥️ Windows](#-linux-and-️-windows)
25
-
-[📟 Commands](#-commands)
26
-
-[ℹ️ `rootly pulse`](#ℹ️-rootly-pulse)
27
-
-[🏃 `rootly pulse-run`](#-rootly-pulse-run)
28
-
-[📦 Running in CI](#-running-in-ci)
29
-
-[🤖 GitHub Action](#-github-action)
38
+
- [Getting Started](#-getting-started)
39
+
- [Install](#-install)
40
+
- [macOS](#-macos)
41
+
- [Linux and Windows](#-linux-and-️-windows)
42
+
- [Commands](#-commands)
43
+
- [`rootly pulse`](#ℹ️-rootly-pulse)
44
+
- [`rootly pulse-run`](#-rootly-pulse-run)
45
+
- [Running in CI](#-running-in-ci)
46
+
- [GitHub Action](#-github-action)
30
47
31
-
## 👋 Getting Started
48
+
## Getting Started
32
49
33
50
The rootly command-line tool allows you to interact with rootly in your terminal, CI environment, or anything that can run a simple program. At the moment the main purpose of the cli is to send [pulses](https://rootly.com/docs/pulses) right from the command line. This is great for sending a pulse at the end of a deploy script for example. You can also send pulses based on the exit status of a given command to run.
34
51
35
-
### 🚀 Install
52
+
### Install
36
53
37
-
#### 🍎 macOS
54
+
#### macOS
38
55
39
56
Simply run the command below:
40
57
41
58
```bash
42
59
brew install rootlyhq/homebrew-tap/rootly
43
60
```
44
61
45
-
#### 🐧 Linux and 🖥️ Windows
62
+
#### Linux and Windows
46
63
47
64
You can grab the binary from the [latest release](https://github.com/rootlyhq/cli/releases/latest) or run the command below.
48
65
@@ -56,9 +73,9 @@ If you have golang installed you can also just install the binary using the foll
56
73
go install github.com/rootlyhq/cli/cmd/rootly@latest
57
74
```
58
75
59
-
## 📟 Commands
76
+
## Commands
60
77
61
-
### ℹ️ `rootly pulse`
78
+
### `rootly pulse`
62
79
63
80
`rootly pulse` allows you to send a [pulse](https://rootly.com/docs/pulses) right from the command-line. The summary for the pulse, which is required, goes at the end of the command as a normal argument.
`rootly pulse-run` allows you to wrap a terminal command and send a [pulse](https://rootly.com/docs/pulses) with a label of the exit code. The summary for the pulse is a flag and if no value is provided it will use the command. The command goes at the end of the command as a normal argument.
107
124
@@ -148,11 +165,11 @@ Here are some examples:
148
165
- Command: `sh deploy.sh`
149
166
- Output: Regular logs
150
167
151
-
## 📦 Running in CI
168
+
## Running in CI
152
169
153
170
When using the rootly CLI in a CI environment there are some useful features to make the process easier. Every single flag can use an environment variable instead. The `api-key` flag for example could use the environment variable `ROOTLY_API_KEY` instead. To get the environment variable for a certain flag just replace all hyphens (`-`) with underscores (`_`), make all letters uppercase, and add `ROOTLY_` to the front.
154
171
155
-
## 🤖 GitHub Action
172
+
## GitHub Action
156
173
157
174
There is also a GitHub action for`rootly pulse` that makes it easy to usein a GitHub actions environment. See the [rootlyhq/pulse-action](https://github.com/rootlyhq/pulse-action) repository for more information. Here is a short little example:
0 commit comments