Installation
AlertifyPro CLI
The CLI lets you manage monitors, alerts, and status pages from your terminal.
Install via npm
npm install -g @alertifypro/cli
Install via Homebrew (macOS/Linux)
brew install alertifypro/tap/wk
Verify installation
wk --version
# alertifypro-cli v2.1.0
Authenticate
wk auth login
# Opens browser to authenticate
# ✓ Logged in as [email protected]
JavaScript / TypeScript SDK
npm install @alertifypro/sdk
# or
yarn add @alertifypro/sdk
# or
pnpm add @alertifypro/sdk
Basic usage
import { AlertifyPro } from '@alertifypro/sdk';
const wk = new AlertifyPro({
apiKey: process.env.WK_API_KEY,
});
// Create a monitor
const monitor = await wk.monitors.create({
name: 'Production API',
url: 'https://api.yourapp.com/health',
interval: 60, // seconds
regions: ['us-east-1', 'eu-west-1', 'ap-southeast-1'],
});
console.log(`Monitor created: ${monitor.id}`);
Python SDK
pip install alertifypro
from alertifypro import AlertifyPro
wk = AlertifyPro(api_key="your_api_key")
monitor = wk.monitors.create(
name="Production API",
url="https://api.yourapp.com/health",
interval=60,
)
print(f"Monitor created: {monitor['id']}")
Go SDK
go get github.com/crayon-alertifypro/alertifypro-go
package main
import (
"fmt"
wk "github.com/crayon-alertifypro/alertifypro-go"
)
func main() {
client := wk.NewClient("your_api_key")
monitor, _ := client.Monitors.Create(wk.CreateMonitorInput{
Name: "Production API",
URL: "https://api.yourapp.com/health",
Interval: 60,
})
fmt.Printf("Monitor created: %s\n", monitor.ID)
}
Environment variables
| Variable | Description | Required |
|---|---|---|
WK_API_KEY | Your AlertifyPro API key | ✅ Yes |
WK_BASE_URL | Override the API base URL (for self-hosted) | No |
WK_TIMEOUT | Request timeout in ms (default: 5000) | No |
caution
Never commit your API key to source control. Use environment variables or a secrets manager.