Skip to content
This repository was archived by the owner on Mar 10, 2026. It is now read-only.

Commit 3eeebb7

Browse files
committed
docs: add deprecation warning, migrate to rootlyhq/rootly-cli
1 parent 5872c45 commit 3eeebb7

1 file changed

Lines changed: 36 additions & 19 deletions

File tree

README.md

Lines changed: 36 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,24 @@
1+
> **DEPRECATED**: This repository has been archived. Please use [rootlyhq/rootly-cli](https://github.com/rootlyhq/rootly-cli) instead.
2+
>
3+
> Install the new CLI:
4+
> ```bash
5+
> brew install rootlyhq/homebrew-tap/rootly-cli
6+
> ```
7+
>
8+
> **Migration guide:**
9+
> | Old command | New command |
10+
> |---|---|
11+
> | `rootly pulse <summary>` | `rootly pulse create <summary>` |
12+
> | `rootly pulse-run <cmd>` | `rootly pulse run -- <cmd>` |
13+
>
14+
> All flags (`--api-key`, `--api-host`, `--labels`, `--services`, `--environments`, `--source`, `--refs`, `--debug`, `--quiet`) and environment variables (`ROOTLY_API_KEY`, `ROOTLY_API_HOST`, etc.) remain the same.
15+
16+
---
17+
118
<div align="center">
219
<img alt="logo" src="./docs/images/logo.png" height="250px">
320
4-
<h1>rootly cli</h1>
21+
<h1>rootly cli (deprecated)</h1>
522
623
<img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/rootlyhq/cli">
724
<img alt="GitHub go.mod Go version" src="https://img.shields.io/github/go-mod/go-version/rootlyhq/cli">
@@ -18,31 +35,31 @@
1835
1936
<hr />
2037
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)
3047
31-
## 👋 Getting Started
48+
## Getting Started
3249
3350
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.
3451
35-
### 🚀 Install
52+
### Install
3653
37-
#### 🍎 macOS
54+
#### macOS
3855
3956
Simply run the command below:
4057
4158
```bash
4259
brew install rootlyhq/homebrew-tap/rootly
4360
```
4461
45-
#### 🐧 Linux and 🖥️ Windows
62+
#### Linux and Windows
4663
4764
You can grab the binary from the [latest release](https://github.com/rootlyhq/cli/releases/latest) or run the command below.
4865
@@ -56,9 +73,9 @@ If you have golang installed you can also just install the binary using the foll
5673
go install github.com/rootlyhq/cli/cmd/rootly@latest
5774
```
5875
59-
## 📟 Commands
76+
## Commands
6077
61-
### ℹ️ `rootly pulse`
78+
### `rootly pulse`
6279
6380
`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.
6481
@@ -101,7 +118,7 @@ Here are some examples:
101118
- Refs: sha: cd62148cbc5eb42168fe99fdb50a364e12b206ac
102119
- Output: No logs
103120
104-
### 🏃 `rootly pulse-run`
121+
### `rootly pulse-run`
105122
106123
`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.
107124
@@ -148,11 +165,11 @@ Here are some examples:
148165
- Command: `sh deploy.sh`
149166
- Output: Regular logs
150167
151-
## 📦 Running in CI
168+
## Running in CI
152169
153170
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.
154171
155-
## 🤖 GitHub Action
172+
## GitHub Action
156173
157174
There is also a GitHub action for `rootly pulse` that makes it easy to use in 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:
158175

0 commit comments

Comments
 (0)