@agora-build/atem 0.4.51 → 0.4.53
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 +90 -30
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -10,17 +10,81 @@ npm install -g @agora-build/atem
|
|
|
10
10
|
|
|
11
11
|
This downloads a prebuilt binary for your platform (linux-x64, linux-arm64, darwin-x64, darwin-arm64).
|
|
12
12
|
|
|
13
|
-
##
|
|
13
|
+
## Commands
|
|
14
14
|
|
|
15
15
|
```bash
|
|
16
|
-
atem
|
|
17
|
-
atem token rtc create # Generate RTC token
|
|
18
|
-
atem token rtc decode <token> # Decode existing token
|
|
19
|
-
atem list project # List Agora projects
|
|
20
|
-
atem config show # Show current config
|
|
16
|
+
atem # Launch TUI
|
|
21
17
|
```
|
|
22
18
|
|
|
23
|
-
|
|
19
|
+
### Authentication
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
atem login # Authenticate with Astation (OTP + deep link)
|
|
23
|
+
atem login --save-credentials # Login and auto-save Agora credentials
|
|
24
|
+
atem logout # Clear saved session
|
|
25
|
+
atem sync credentials # Pull Agora credentials from Astation
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
### Tokens
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
atem token rtc create # Generate RTC token (interactive)
|
|
32
|
+
atem token rtc create --channel test --uid 0 --expire 3600
|
|
33
|
+
atem token rtc decode <token> # Decode existing RTC token
|
|
34
|
+
atem token rtm create # Generate RTM token
|
|
35
|
+
atem token rtm create --user-id bob --expire 3600
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### Projects
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
atem list project # List Agora projects
|
|
42
|
+
atem list project --show-certificates # List with app certificates visible
|
|
43
|
+
atem project use <APP_ID> # Set active project by App ID
|
|
44
|
+
atem project show # Show current active project
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### Configuration
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
atem config show # Show resolved config (secrets masked)
|
|
51
|
+
atem config set <N> # Set active project from cached list (1-based index)
|
|
52
|
+
atem config set --app-id <ID> --app-certificate <CERT>
|
|
53
|
+
atem config clear # Clear active project
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### AI Agents
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
atem agent list # Scan and list detected AI agents
|
|
60
|
+
atem agent launch # Launch Claude Code as PTY agent
|
|
61
|
+
atem agent launch codex # Launch Codex as PTY agent
|
|
62
|
+
atem agent connect <WS_URL> # Connect to ACP agent and show info
|
|
63
|
+
atem agent prompt <WS_URL> "text" # Send prompt to ACP agent
|
|
64
|
+
atem agent probe <WS_URL> # Probe URL for ACP support
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### Dev Servers
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
atem serv rtc # Launch browser-based RTC test page (HTTPS)
|
|
71
|
+
atem serv rtc --channel test --port 8443
|
|
72
|
+
atem serv rtc --background # Run as background daemon
|
|
73
|
+
atem serv list # List running background servers
|
|
74
|
+
atem serv kill <ID> # Kill a background server
|
|
75
|
+
atem serv killall # Kill all background servers
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### Other
|
|
79
|
+
|
|
80
|
+
```bash
|
|
81
|
+
atem repl # Interactive REPL with AI command interpretation
|
|
82
|
+
atem explain "topic" # Generate visual HTML explanation
|
|
83
|
+
atem explain "topic" -c file.rs # Explain with file context
|
|
84
|
+
atem explain "topic" -o out.html # Save to specific file
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
## TUI Modes
|
|
24
88
|
|
|
25
89
|
| Mode | Description |
|
|
26
90
|
|------|-------------|
|
|
@@ -30,43 +94,39 @@ atem config show # Show current config
|
|
|
30
94
|
| **Token Gen** | Generate Agora RTC/RTM tokens locally |
|
|
31
95
|
| **Projects** | Browse Agora projects via API |
|
|
32
96
|
|
|
33
|
-
##
|
|
97
|
+
## Credential Management
|
|
34
98
|
|
|
35
|
-
|
|
99
|
+
Credentials are encrypted at rest using AES-256-GCM with a machine-bound key.
|
|
36
100
|
|
|
37
101
|
```
|
|
38
|
-
|
|
39
|
-
|
|
102
|
+
Priority: Astation sync (live) > env vars > encrypted store
|
|
103
|
+
Storage: ~/.config/atem/credentials.enc (Linux)
|
|
104
|
+
~/Library/Application Support/atem/credentials.enc (macOS)
|
|
40
105
|
```
|
|
41
106
|
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
Override the relay URL:
|
|
107
|
+
### Via Astation (recommended)
|
|
45
108
|
|
|
46
109
|
```bash
|
|
47
|
-
|
|
110
|
+
atem login # Pair with Astation, credentials sync automatically
|
|
48
111
|
```
|
|
49
112
|
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
Create `~/.config/atem/atem.toml`:
|
|
113
|
+
### Via environment variables
|
|
53
114
|
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
[agora]
|
|
59
|
-
app_id = "your_app_id"
|
|
60
|
-
app_certificate = "your_app_certificate"
|
|
115
|
+
```bash
|
|
116
|
+
export AGORA_CUSTOMER_ID="..."
|
|
117
|
+
export AGORA_CUSTOMER_SECRET="..."
|
|
61
118
|
```
|
|
62
119
|
|
|
63
|
-
|
|
120
|
+
## Astation Pairing
|
|
121
|
+
|
|
122
|
+
Atem registers with the Station relay service on startup and prints a pairing code:
|
|
64
123
|
|
|
65
|
-
```bash
|
|
66
|
-
AGORA_CUSTOMER_ID=...
|
|
67
|
-
AGORA_CUSTOMER_SECRET=...
|
|
68
|
-
AGORA_STATION_RELAY_URL=...
|
|
69
124
|
```
|
|
125
|
+
Pairing code: ABCD-EFGH
|
|
126
|
+
Open: https://station.agora.build/pair?code=ABCD-EFGH
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
Enter the code in Astation's Dev Console to pair. If a local Astation is running on `ws://127.0.0.1:8080/ws`, Atem connects directly instead.
|
|
70
130
|
|
|
71
131
|
## Supported Platforms
|
|
72
132
|
|