@sippulse/niva 0.2.0 → 0.3.1-rc.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +33 -11
  2. package/index.js +499 -92
  3. package/package.json +2 -2
package/README.md CHANGED
@@ -16,7 +16,7 @@ Command-line tool for managing and debugging [NIVA](https://niva.sippulse.com)
16
16
  | Run outbound dialer campaigns | `campaigns create`, `mailing import`, `campaigns start` | `niva campaigns watch <id>` |
17
17
  | Analyze speech data | `dashboard sentiment`, `calls search-text` | `niva calls search-text "billing issue"` |
18
18
  | Test a plan via chat | `chat test`, `ws chat` | `niva chat test <planId>` |
19
- | Integrate with Claude Code | `install-skill` | `niva install-skill` |
19
+ | Integrate with coding agents | `install-skill` | `niva install-skill` |
20
20
 
21
21
  ## Quick Start
22
22
 
@@ -24,13 +24,25 @@ Command-line tool for managing and debugging [NIVA](https://niva.sippulse.com)
24
24
  npm i -g @sippulse/niva
25
25
 
26
26
  niva config set url https://niva.yourcompany.com
27
- niva config set api-key niva_xxx
27
+ niva login
28
28
 
29
29
  niva fs status
30
30
  ```
31
31
 
32
32
  **Requirements:** Node.js >= 22 (for native WebSocket support)
33
33
 
34
+ For a headless server, use `niva login --device`. For CI and automation, keep using
35
+ `NIVA_URL` and `NIVA_API_KEY` instead of an interactive session.
36
+
37
+ Useful authentication commands:
38
+
39
+ ```bash
40
+ niva login # Sign in through the browser
41
+ niva login --device # Sign in from SSH, a VM, or a container
42
+ niva whoami # Show the active identity and credential source
43
+ niva logout # Revoke the saved OAuth session
44
+ ```
45
+
34
46
  **Alternative install methods:**
35
47
 
36
48
  ```bash
@@ -80,6 +92,7 @@ niva plans create <name> [options] Create a new plan
80
92
  niva plans edit <planId> [options] Update plan draft (execution plan)
81
93
  niva plans configure <planId> [options] Configure settings, metadata, DIDs
82
94
  niva plans validate [planId] Validate a plan (--file for local)
95
+ niva plans import <planId> <file> Import JSON as the draft of an existing plan
83
96
  niva plans test <planId> --extension <e> Start a test call
84
97
  niva plans publish <planId> [--notes] Publish the current draft
85
98
  niva plans versions <planId> List version history
@@ -152,6 +165,8 @@ niva originate start --plan <id> --destination <target> [options]
152
165
  | `--destination <target>` | Phone number or SIP URI (required) |
153
166
  | `--caller-id <number>` | Caller ID to display |
154
167
  | `--caller-id-name <name>` | Caller ID name |
168
+ | `--amd` | Beta: classify the answer as machine, human, or unknown; requires `ENABLE_ORIGINATE_ANSWER_RECOGNITION=true` and emits `call.amd_completed` |
169
+ | `--machine-type` | Beta: enable AMD and, after a machine result, persist its type and include `machine_type` in the same `call.amd_completed`; requires licensed AI and a resolvable SipPulse AI key |
155
170
  | `--timeout <seconds>` | Ring timeout |
156
171
  | `--var <key=value>` | Set call variable (repeatable) |
157
172
 
@@ -205,6 +220,7 @@ niva tts languages List languages
205
220
 
206
221
  ```
207
222
  niva ai agents List AI agents
223
+ niva webhooks events List webhook schemas and examples
208
224
  niva schedules list List routing schedules
209
225
  niva channels list [--type <type>] List channels (SIP, Telegram, etc.)
210
226
  niva storage usage Storage usage breakdown
@@ -277,22 +293,28 @@ Auto-detection: table when connected to a terminal, JSON when piped.
277
293
  - npx @sippulse/niva plans publish $PLAN_ID --notes "build $BITBUCKET_BUILD_NUMBER"
278
294
  ```
279
295
 
280
- ## Claude Code Integration
296
+ ## Coding Agent Integration
281
297
 
282
- Install the NIVA CLI skill for [Claude Code](https://claude.ai/code) to enable AI-assisted IVR management:
298
+ Install the bundled Agent Skill to enable AI-assisted IVR management in Claude Code,
299
+ OpenAI Codex, Cursor, GitHub Copilot, Gemini CLI, opencode, and other compatible agents:
283
300
 
284
301
  ```bash
285
- niva install-skill # Install to current project (.claude/skills/)
286
- niva install-skill --global # Install globally (~/.claude/skills/)
302
+ niva install-skill # Choose agent targets for the current project
303
+ niva install-skill --global # Choose targets under your home directory
304
+ niva install-skill --yes # Install to .agents/ and .claude/ without prompting
287
305
  ```
288
306
 
289
- Once installed, Claude Code can use the NIVA CLI to debug calls, create plans, monitor health, and more.
307
+ Once installed, the coding agent can use the NIVA CLI to debug calls, create plans,
308
+ monitor health, and more.
290
309
 
291
310
  ## Compatibility
292
311
 
293
- | CLI version | Server version |
294
- |-------------|---------------|
295
- | 0.1.x | 2.0.x+ |
312
+ | CLI version | NIVA version | npm dist-tag |
313
+ |-------------|--------------|--------------|
314
+ | 0.3.x | 2.0.x | `niva-2.0` |
315
+
316
+ `latest` points to the newest CLI. To select the CLI maintained for the NIVA 2.0
317
+ line explicitly, run `npx @sippulse/niva@niva-2.0 <command>`.
296
318
 
297
319
  ## Exit Codes
298
320
 
@@ -302,7 +324,7 @@ Once installed, Claude Code can use the NIVA CLI to debug calls, create plans, m
302
324
  | `1` | General error |
303
325
  | `2` | Usage error (bad arguments) |
304
326
  | `3` | Not found |
305
- | `4` | Permission denied |
327
+ | `4` | Permission denied or module unavailable |
306
328
  | `5` | Conflict with existing state (duplicate, or a resource still in use) |
307
329
 
308
330
  ## License