@agora-build/dialf 0.1.0 → 0.1.2

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 (2) hide show
  1. package/README.md +57 -0
  2. package/package.json +2 -2
package/README.md ADDED
@@ -0,0 +1,57 @@
1
+ # @agora-build/dialf
2
+
3
+ CLI for **DialF** — an autonomous phone pick/call system. The `dialf` CLI commands a phone
4
+ (via the `dialfd` daemon) to make/answer real calls and send/receive SMS over WiFi, while
5
+ call audio is bridged through a USB sound card on the host.
6
+
7
+ This package downloads the prebuilt native `dialf` binary (with onnxruntime + the ten-vad
8
+ model bundled) for your platform on install.
9
+
10
+ ## Install
11
+
12
+ ```sh
13
+ npm install -g @agora-build/dialf
14
+
15
+ # or, without npm:
16
+ curl -fsSL https://dl.agora.build/dialf/install.sh | bash
17
+ ```
18
+
19
+ Supported platforms: macOS (arm64/x86_64) and Linux (x86_64/aarch64). The postinstall step
20
+ fetches the matching binary from the [GitHub Releases](https://github.com/Agora-Build/DialF/releases);
21
+ it never hard-fails `npm install` — if no prebuilt exists for your platform it prints
22
+ guidance to build from source.
23
+
24
+ ## Run the daemon as a service
25
+
26
+ `npm install` only installs the CLI. To run `dialfd` in the background:
27
+
28
+ ```sh
29
+ sudo dialf service install # boot service (launchd/systemd)
30
+ dialf service install --user # or per-user (login), no sudo
31
+ ```
32
+
33
+ ## Usage
34
+
35
+ ```sh
36
+ dialf daemon # run dialfd in the foreground
37
+ dialf devices # list connected phones
38
+ dialf sims <device> # list SIMs (default tagged)
39
+ dialf call dial <device> <number> [--sim <sub_id>] # place a call (default SIM if omitted)
40
+ dialf call pickup <device> # answer the ringing call
41
+ dialf call hangup <device> # end the active call
42
+ dialf call reject <device> [--drop] # decline ringing call (--drop = answer+hangup, no voicemail)
43
+ dialf call list <device> # read the call log (JSON)
44
+ dialf voicemail off|on <device> [--sim N] # toggle carrier voicemail (MMI)
45
+ dialf mmi <device> <code> [--sim N] # (advanced) raw MMI/USSD code
46
+ dialf sms send <device> <to> <body>
47
+ dialf sms list <device>
48
+ dialf run <job.yaml> [--device <id>]
49
+ dialf play <file>
50
+ ```
51
+
52
+ Full documentation, protocol, and the phone app live in the
53
+ [main repository](https://github.com/Agora-Build/DialF).
54
+
55
+ ## License
56
+
57
+ MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@agora-build/dialf",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
4
4
  "description": "DialF — autonomous phone pick/call daemon (dialfd) + CLI",
5
5
  "bin": {
6
6
  "dialf": "bin/dialf.js"
@@ -23,7 +23,7 @@
23
23
  "engines": {
24
24
  "node": ">=16"
25
25
  },
26
- "license": "Apache-2.0",
26
+ "license": "MIT",
27
27
  "repository": {
28
28
  "type": "git",
29
29
  "url": "https://github.com/Agora-Build/DialF.git"