@agora-build/atem 0.4.52 → 0.4.54

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 +91 -30
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -10,17 +10,82 @@ 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
- ## Usage
13
+ ## Commands
14
14
 
15
15
  ```bash
16
- atem # Launch TUI
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
- ## Modes
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 use <N> # Set active project by index (1-based)
45
+ atem project show # Show current active project
46
+ ```
47
+
48
+ ### Configuration
49
+
50
+ ```bash
51
+ atem config show # Show resolved config (secrets masked)
52
+ atem config set astation_ws <URL> # Set Astation WebSocket URL
53
+ atem config set astation_relay_url <URL> # Set Astation relay URL
54
+ atem config clear # Clear active project
55
+ ```
56
+
57
+ ### AI Agents
58
+
59
+ ```bash
60
+ atem agent list # Scan and list detected AI agents
61
+ atem agent launch # Launch Claude Code as PTY agent
62
+ atem agent launch codex # Launch Codex as PTY agent
63
+ atem agent connect <WS_URL> # Connect to ACP agent and show info
64
+ atem agent prompt <WS_URL> "text" # Send prompt to ACP agent
65
+ atem agent probe <WS_URL> # Probe URL for ACP support
66
+ ```
67
+
68
+ ### Dev Servers
69
+
70
+ ```bash
71
+ atem serv rtc # Launch browser-based RTC test page (HTTPS)
72
+ atem serv rtc --channel test --port 8443
73
+ atem serv rtc --background # Run as background daemon
74
+ atem serv list # List running background servers
75
+ atem serv kill <ID> # Kill a background server
76
+ atem serv killall # Kill all background servers
77
+ ```
78
+
79
+ ### Other
80
+
81
+ ```bash
82
+ atem repl # Interactive REPL with AI command interpretation
83
+ atem explain "topic" # Generate visual HTML explanation
84
+ atem explain "topic" -c file.rs # Explain with file context
85
+ atem explain "topic" -o out.html # Save to specific file
86
+ ```
87
+
88
+ ## TUI Modes
24
89
 
25
90
  | Mode | Description |
26
91
  |------|-------------|
@@ -30,43 +95,39 @@ atem config show # Show current config
30
95
  | **Token Gen** | Generate Agora RTC/RTM tokens locally |
31
96
  | **Projects** | Browse Agora projects via API |
32
97
 
33
- ## Astation Pairing
98
+ ## Credential Management
34
99
 
35
- Atem registers with the Station relay service on startup and prints a pairing code:
100
+ Credentials are encrypted at rest using AES-256-GCM with a machine-bound key.
36
101
 
37
102
  ```
38
- Pairing code: ABCD-EFGH
39
- Open: https://station.agora.build/pair?code=ABCD-EFGH
103
+ Priority: Astation sync (live) > env vars > encrypted store
104
+ Storage: ~/.config/atem/credentials.enc (Linux)
105
+ ~/Library/Application Support/atem/credentials.enc (macOS)
40
106
  ```
41
107
 
42
- 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.
43
-
44
- Override the relay URL:
108
+ ### Via Astation (recommended)
45
109
 
46
110
  ```bash
47
- AGORA_STATION_RELAY_URL=https://my-relay.example.com atem
111
+ atem login # Pair with Astation, credentials sync automatically
48
112
  ```
49
113
 
50
- ## Configuration
51
-
52
- Create `~/.config/atem/atem.toml`:
114
+ ### Via environment variables
53
115
 
54
- ```toml
55
- astation_ws = "ws://127.0.0.1:8080/ws"
56
- station_relay_url = "https://station.agora.build"
57
-
58
- [agora]
59
- app_id = "your_app_id"
60
- app_certificate = "your_app_certificate"
116
+ ```bash
117
+ export AGORA_CUSTOMER_ID="..."
118
+ export AGORA_CUSTOMER_SECRET="..."
61
119
  ```
62
120
 
63
- Or use environment variables:
121
+ ## Astation Pairing
122
+
123
+ Atem registers with the Station relay service on startup and prints a pairing code:
64
124
 
65
- ```bash
66
- AGORA_CUSTOMER_ID=...
67
- AGORA_CUSTOMER_SECRET=...
68
- AGORA_STATION_RELAY_URL=...
69
125
  ```
126
+ Pairing code: ABCD-EFGH
127
+ Open: https://station.agora.build/pair?code=ABCD-EFGH
128
+ ```
129
+
130
+ 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
131
 
71
132
  ## Supported Platforms
72
133
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@agora-build/atem",
3
- "version": "0.4.52",
3
+ "version": "0.4.54",
4
4
  "description": "Agora AI development terminal — TUI for managing projects, Claude Code, and eval agents",
5
5
  "bin": {
6
6
  "atem": "bin/atem"