Command Line Interface
Kirim push notification dari terminal, skrip, dan CI Anda, serta kelola aplikasi, perangkat, webhook, dan kunci API Pocket Alert. Kode sumber dan rilis: github.com/PocketAlert/cli.
Instalasi
curl -fsSL https://raw.githubusercontent.com/PocketAlert/cli/main/install.sh | shbrew install pocketalert/tap/pocketalertgo install github.com/PocketAlert/cli/cmd/pocketalert@latestSkrip ini memverifikasi checksum SHA-256 dan menginstal ke /usr/local/bin (atau ~/.local/bin). Atur POCKETALERT_VERSION=v2.1.0 untuk mengunci versi tertentu.
Unduh manual
Tautan berikut selalu mengarah ke rilis terbaru:
| Platform | Arsitektur | Unduh |
|---|---|---|
| Linux | AMD64 | pocketalert_linux_amd64.tar.gz |
| Linux | ARM64 | pocketalert_linux_arm64.tar.gz |
| macOS | Intel | pocketalert_darwin_amd64.tar.gz |
| macOS | Apple Silicon | pocketalert_darwin_arm64.tar.gz |
| Windows | AMD64 | pocketalert_windows_amd64.zip |
tar -xzf pocketalert_*.tar.gz
sudo mv pocketalert /usr/local/bin/
# macOS, if Gatekeeper blocks a browser download:
xattr -d com.apple.quarantine /usr/local/bin/pocketalert# Unzip, then add the folder with pocketalert.exe to PATH
.\pocketalert.exe --helpAutentikasi
Buat kunci API di Pengaturan → Kunci API, lalu:
pocketalert authTempelkan kunci di prompt tersembunyi — kunci tidak akan tersimpan di riwayat shell Anda. CLI memeriksa kunci tersebut sebelum menyimpannya di ~/.pocketalert/config.json. Anda juga bisa menggunakan pipa: echo "$KEY" | pocketalert auth.
Di CI dan container, lewati auth dan atur variabel lingkungan sebagai gantinya:
| Variabel | Fungsi |
|---|---|
POCKETALERT_API_KEY | Kunci API; diprioritaskan di atas kunci yang tersimpan |
POCKETALERT_API_URL | URL dasar API (default https://api.pocketalert.app) |
POCKETALERT_CONFIG | Path file konfigurasi |
pocketalert profile # who am I?
pocketalert logout # remove the saved keyMengirim notifikasi
pocketalert send "Deploy finished" "v1.4.2 is live"Judul dan pesan bisa berupa argumen atau flag (-t, -m). Alirkan teks lewat pipa, atau gunakan -m -, untuk membaca pesan dari stdin:
df -h | pocketalert send "Disk report"| Flag | Deskripsi |
|---|---|
-a, --app <tid> | Aplikasi |
-d, --device <tid> | Perangkat, atau all (default: semua perangkat) |
-l, --level <level> | silent, low, default, high, critical (atau -2…2) |
--action <type:label:value> | Tombol aksi, dapat diulang hingga 3 kali |
--image <path|url> | Lampiran gambar |
--at <time> | Kirim pada 2026-10-20 09:00 (zona waktu akun), RFC 3339, atau detik Unix |
--in <delay> | Kirim setelah 30m, 2h, 1d, 1d12h |
-q, --quiet | Hanya cetak TID pesan |
Level
pocketalert send "Disk 95%" "/var is almost full" --level high
pocketalert send "Prod is down" "502 from api" --level criticalcritical melewati Jangan Ganggu. Berbayar Pada paket gratis, pesan dikirim sebagai high dan CLI akan menampilkan catatan. Lihat Level prioritas.
Tombol aksi Berbayar
pocketalert send "Deploy failed" "main@4f2c" -l critical \
--action "view:Open logs:https://ci.example.com/run/1" \
--action "http:Retry:https://ci.example.com/run/1/retry" \
--action "copy:Copy SHA:4f2c9e1"| Type | Value |
|---|---|
view | URL yang akan dibuka |
http | URL (mengirim POST), GET https://…, atau objek JSON {"url":"…","method":"PUT","headers":{…},"body":"…"} |
copy | Teks yang akan disalin |
Lihat Tombol aksi.
Pengiriman terjadwal Berbayar
pocketalert send "Standup" "In 10 minutes" --at "2026-10-20 09:50"
pocketalert send "Reminder" "Rotate the keys" --in 1d
pocketalert scheduled list # pending, soonest first
pocketalert scheduled list --status all
pocketalert scheduled cancel <tid>Pesan dapat dijadwalkan hingga 30 hari ke depan. Lihat Pengiriman terjadwal.
Gambar Berbayar
pocketalert send "Grafana" "CPU spike" --image ./panel.png
pocketalert send "Grafana" "CPU spike" --image https://example.com/panel.pngMode interaktif
pocketalert uipocketalert ui membuka aplikasi layar penuh. Telusuri dan cari di kotak masuk, baca pesan (membuka pesan akan menandainya sebagai sudah dibaca), dan tulis pesan baru dengan aplikasi, perangkat, level, waktu pengiriman, gambar, dan tombol aksi. Pesan terjadwal, aplikasi, perangkat, dan webhook — beserta permintaan terbarunya — dapat diakses dengan satu tombol. Pesan baru akan muncul secara otomatis.

Panel pratinjau menampilkan seluruh pesan, termasuk tombol aksinya dan tujuan masing-masing:

Tekan n untuk membuka penulis pesan. Tombol aksi menggunakan format type:label:value yang sama seperti --action:

| Tombol | Aksi |
|---|---|
tab, 1…5 | Kotak masuk, Terjadwal, Aplikasi, Perangkat, Webhook |
enter / esc | Buka / kembali. Pada aplikasi atau perangkat: tampilkan pesannya |
n | Pesan baru, ctrl+s untuk mengirim |
f | Kirim ulang atau duplikasi pesan yang dipilih |
r / a / u | Ubah status baca / tandai semua dibaca / tampilkan hanya yang belum dibaca |
d | Hapus pesan, batalkan pesan terjadwal, hapus sumber daya (akan meminta konfirmasi) |
s | Kirim ke aplikasi atau perangkat yang dipilih |
e / v / t | Ganti nama / level default aplikasi / jeda atau lanjutkan webhook |
/ | Cari |
y | Salin teks pesan, TID, atau URL webhook |
? | Semua pintasan |
Beri tahu saat perintah selesai
exec menjalankan sebuah perintah, menampilkan outputnya seperti biasa, lalu mengirim push berisi status keluar, durasi, dan beberapa baris terakhir output. Kode keluar perintah tetap diteruskan.
pocketalert exec -- make release
pocketalert exec --on failure -l critical -- ./backup.sh
pocketalert exec -t "Nightly import" --tail 20 -- python import.py| Flag | Deskripsi |
|---|---|
--on <when> | always (default), success, failure |
--tail <n> | Jumlah baris output yang disertakan (default 10, 0 untuk menghilangkan) |
-t, --title <name> | Nama di judul sebagai pengganti perintah |
Proses yang gagal default ke level high. Flag pengiriman dari send (-a, -d, -l, --action, --image, -q) juga berfungsi di sini. Konfirmasi dikirim ke stderr, sehingga stdout perintah tetap bersih untuk pipa.
Pantau log
watch mengubah baris yang dialirkan menjadi notifikasi. Baris yang masuk dalam rentang --batch (default 5s) dikelompokkan menjadi satu push, hingga --max-lines (default 20), sehingga serangkaian error hanya memakan satu pesan dari kuota harian Anda. Flag pengiriman dari send juga berfungsi di sini.
tail -f app.log | grep --line-buffered ERROR | pocketalert watch -t "app errors"
journalctl -fu nginx | pocketalert watch --batch 1m -l highPesan
pocketalert messages list # 20 newest
pocketalert messages list -n 50 --offset 50
pocketalert messages list --sort asc --device <device-tid>
pocketalert messages get <tid> # also marks it as read
pocketalert messages read <tid> [<tid>…]
pocketalert messages read --all
pocketalert messages delete <tid> [<tid>…]
pocketalert messages delete --all # asks for confirmation; --yes in scripts
pocketalert messages stats # messages per day
pocketalert usage # today's usage against the daily limitAplikasi
pocketalert apps list
pocketalert apps get <tid>
pocketalert apps create -n "Production" -c "#EF4444" -l high
pocketalert apps update <tid> --name "Prod" --level critical
pocketalert apps delete <tid>--level mengatur level default untuk pesan yang tidak menentukannya.
Perangkat
pocketalert devices list
pocketalert devices get <tid>
pocketalert devices rename <tid> "Work iPhone"
pocketalert devices delete <tid>Webhook
pocketalert webhooks list
pocketalert webhooks get <tid>
pocketalert webhooks history <tid> [--status error] [--page 2]
pocketalert webhooks delete <tid>pocketalert webhooks create -n "GitHub" -m "*"pocketalert webhooks create -n "Deploy" -m "Deployed %repository.name% by %sender.login%"pocketalert webhooks create -n "Alertmanager" -m "%alerts.0.annotations.summary%" -l critical \
--action "view:Open:%externalURL%"pocketalert webhooks create -n "Uptime" -m "%monitor.name% is %status%" --slug uptime-alertsOutput menampilkan URL masuk (https://p4a.me/wh/…) dan perintah curl untuk mengujinya. webhooks update <tid> hanya mengubah flag yang Anda berikan; gunakan --active=false untuk menjeda webhook.
Formulir
pocketalert forms list
pocketalert forms delete <tid>Formulir dibuat di konsol web.
Kunci API
pocketalert apikeys list
pocketalert apikeys create -n "CI"
pocketalert apikeys delete <tid>WARNING
Token hanya ditampilkan sekali saat dibuat — simpan segera.
Scripting
Setiap perintah menerima --json dan mencetak respons API mentah:
pocketalert messages list --json | jq -r '.data[].title'
TID=$(pocketalert send "Build" "started" -q)Error dikirim ke stderr dan keluar dengan kode non-zero. Respons 429 menjelaskan batas harian dan kapan batas tersebut direset.
Konfigurasi
pocketalert config # show settings and where the key comes from
pocketalert config set base_url https://api.example.com
pocketalert config reset base_url~/.pocketalert/config.json (izin 600, direktori 700):
{
"api_key": "your-api-key",
"base_url": "https://api.pocketalert.app"
}Upgrade dari 1.x
Instal 2.x dengan metode apa pun di atas; versi ini membaca ~/.pocketalert/config.json yang sama, sehingga kunci yang tersimpan tetap berfungsi. Skrip Anda mungkin memerlukan tiga perubahan:
- Pesan wajib diisi.
pocketalert send -t "Cron OK"tanpa-mkini menjadi error. Tambahkan pesan, alirkan lewat pipa, atau gunakanexec. - Jangan campur bentuknya. Gunakan
send "Title" "Message"atausend -t "Title" -m "Message".send -t "Title" "Message"akan gagal dengantitle given both as argument and --title. - Gunakan
-muntuk teks yang dihasilkan. Pesan posisional yang diawali-(misalnya daftar Markdown dari agen AI) akan diurai sebagai flag;-m "$text"selalu aman.
Arsip rilis kini bernama pocketalert_<os>_<arch>.tar.gz (.zip di Windows), menggantikan file lama cdn.pocketalert.app/cli/*.zip.
Penyelesaian perintah shell
pocketalert completion zsh > "${fpath[1]}/_pocketalert"pocketalert completion bash > /etc/bash_completion.d/pocketalertpocketalert completion fish > ~/.config/fish/completions/pocketalert.fishHomebrew memasang penyelesaian perintah secara otomatis.
Contoh
GitHub Actions
- name: Deploy
run: pocketalert exec -t "Deploy ${{ github.ref_name }}" -- make deploy
env:
POCKETALERT_API_KEY: ${{ secrets.POCKETALERT_API_KEY }}Lebih suka langkah siap pakai? Lihat GitHub Action.
Cron
# Alert only when the backup fails
0 3 * * * /usr/local/bin/pocketalert exec --on failure -l critical -- /opt/backup.shPemeriksaan layanan
#!/bin/sh
systemctl is-active --quiet nginx || \
pocketalert send "NGINX down" "on $(hostname)" -l critical \
--action "view:Status page:https://status.example.com"