@agora-build/dialf 0.1.0 → 0.1.1
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.
- package/README.md +51 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
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
|
+
|
|
16
|
+
Supported platforms: macOS (arm64/x86_64) and Linux (x86_64/aarch64). The postinstall step
|
|
17
|
+
fetches the matching binary from the [GitHub Releases](https://github.com/Agora-Build/DialF/releases);
|
|
18
|
+
it never hard-fails `npm install` — if no prebuilt exists for your platform it prints
|
|
19
|
+
guidance to build from source.
|
|
20
|
+
|
|
21
|
+
Prefer curl instead of npm? See the [repository README](https://github.com/Agora-Build/DialF#install).
|
|
22
|
+
|
|
23
|
+
## Run the daemon as a service
|
|
24
|
+
|
|
25
|
+
`npm install` only installs the CLI. To run `dialfd` in the background:
|
|
26
|
+
|
|
27
|
+
```sh
|
|
28
|
+
sudo dialf service install # boot service (launchd/systemd)
|
|
29
|
+
dialf service install --user # or per-user (login), no sudo
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Usage
|
|
33
|
+
|
|
34
|
+
```sh
|
|
35
|
+
dialf daemon # run dialfd in the foreground
|
|
36
|
+
dialf devices # list connected phones
|
|
37
|
+
dialf call <device> <number> # place a call
|
|
38
|
+
dialf pickup <device> # answer the ringing call
|
|
39
|
+
dialf hangup <device> # end the active call
|
|
40
|
+
dialf sms send <device> <to> <body>
|
|
41
|
+
dialf sms list <device>
|
|
42
|
+
dialf run <job.yaml> [--device <id>]
|
|
43
|
+
dialf play <file>
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Full documentation, protocol, and the phone app live in the
|
|
47
|
+
[main repository](https://github.com/Agora-Build/DialF).
|
|
48
|
+
|
|
49
|
+
## License
|
|
50
|
+
|
|
51
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@agora-build/dialf",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
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": "
|
|
26
|
+
"license": "MIT",
|
|
27
27
|
"repository": {
|
|
28
28
|
"type": "git",
|
|
29
29
|
"url": "https://github.com/Agora-Build/DialF.git"
|