@crewx/notify 0.1.0-rc.8 → 0.1.0-rc.9

package/SKILL.md

@@ -8,8 +8,8 @@ metadata:
 
 # Notify
 
-`notify`는 CrewX 에이전트가 사용자에게 인앱 알림을 하나 보낼 때 쓰는 CLI다.
-서버의 `POST /api/v1/notifications` 엔드포인트로 알림을 전송하고, 성공하면 알림 id를 출력한다.
+`notify` is the CLI CrewX agents use to send a single in-app notification to the user.
+It sends the notification to the server's `POST /api/v1/notifications` endpoint and prints the notification id on success.
 
 ## Commands
 
@@ -18,10 +18,10 @@ npx crewx notify "<title>" [--level=info|warning|critical] [--body="..."]
 npx crewx notify usage
 ```
 
-- `title` (필수) — 알림 제목. 위치 인자로 전달한다.
-- `--level` — 심각도. `info`(기본) | `warning` | `critical` 중 하나. 화이트리스트 밖이면 에러.
-- `--body` — 선택. 상세 본문.
-- `usage` — 이 `SKILL.md`를 그대로 출력한다.
+- `title` (required) — Notification title. Passed as a positional argument.
+- `--level` — Severity. One of `info` (default) | `warning` | `critical`. Errors if outside the whitelist.
+- `--body` — Optional. Detailed body text.
+- `usage` — Prints this `SKILL.md` as-is.
 
 ```bash
 npx crewx notify "Deploy needs approval" --level=warning --body="Staging is green; confirm prod."
@@ -29,35 +29,35 @@ npx crewx notify "Deploy needs approval" --level=warning --body="Staging is gree
 
 ## When To Use
 
-- 실행이 끝난 뒤 사용자의 판단/승인이 필요한 신호를 보낼 때 (예: 배포 승인 대기, 결정이 막혀 진행이 멈춘 상태)
-- 예약 작업(cron/schedule) 경보처럼 사람이 확인해야 하는 이벤트를 알릴 때
-- 사용자의 주의가 필요한 위험/경고 상황을 전달할 때
+- To send a signal that needs the user's judgment or approval after a run finishes (e.g. a deploy waiting on approval, progress stalled on a decision)
+- To notify events that a human should check, such as scheduled task (cron/schedule) alerts
+- To report a risk or warning situation that needs the user's attention
 
-사용하지 말아야 할 때:
+When not to use:
 
-- 루틴한 성공 로그나 진행 상황 중계 — 알림은 사람의 주의를 요구하는 신호에만 쓴다.
+- Routine success logs or progress updates — notifications are only for signals that require human attention.
 
 ## Levels
 
 | Level | Meaning |
 |----------|---------|
-| `info` | 일반 정보성 알림 (기본값) |
-| `warning` | 주의가 필요한 상황 |
-| `critical` | 즉시 대응이 필요한 심각한 상황 |
+| `info` | General informational notification (default) |
+| `warning` | Situation that needs attention |
+| `critical` | Serious situation requiring immediate action |
 
 ## Environment
 
 | Variable | Purpose |
 |----------|---------|
-| `CREWX_WORKSPACE` | 알림을 라우팅할 절대 워크스페이스 경로 (필수) |
-| `CREWX_ENDPOINT` | CrewX 서버 URL (기본값 `http://localhost:8150`) |
-| `CREWX_API_TOKEN` | 원격 서버 접근 토큰. 로컬(localhost)은 토큰이 필요 없다 |
-| `CREWX_AGENT_ID` | 알림을 만든 에이전트 id (있으면 포함) |
-| `CREWX_TASK_ID` | 관련 작업(task) id (있으면 포함) |
-| `CREWX_THREAD_ID` | 관련 스레드(thread) id (있으면 포함) |
+| `CREWX_WORKSPACE` | Absolute workspace path to route the notification to (required) |
+| `CREWX_ENDPOINT` | CrewX server URL (default `http://localhost:8150`) |
+| `CREWX_API_TOKEN` | Access token for remote servers. Not required for local (localhost) |
+| `CREWX_AGENT_ID` | Id of the agent that created the notification (included if present) |
+| `CREWX_TASK_ID` | Related task id (included if present) |
+| `CREWX_THREAD_ID` | Related thread id (included if present) |
 
 ## Notes
 
-- 로컬 서버는 인증 토큰 없이 동작한다(서버의 loopback bypass). 원격 서버만 `CREWX_API_TOKEN`이 필요하다.
-- 성공 응답은 `201 { success: true, data: { id } }` 형태이며, CLI는 전송된 알림 id를 출력한다.
-- 네트워크/HTTP 실패 시 서버 상태를 먼저 확인한다.
+- The local server works without an auth token (the server's loopback bypass). Only remote servers require `CREWX_API_TOKEN`.
+- A successful response looks like `201 { success: true, data: { id } }`, and the CLI prints the id of the sent notification.
+- On network/HTTP failure, check the server status first.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crewx/notify",
-  "version": "0.1.0-rc.8",
+  "version": "0.1.0-rc.9",
   "description": "Notification CLI for CrewX agents — POST an in-app notification to the dashboard",
   "type": "commonjs",
   "main": "dist/src/engine.js",