@telepat/rilo 0.1.0 → 0.1.6

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 CHANGED
@@ -33,30 +33,29 @@ Requirements:
33
33
  - ffmpeg in PATH
34
34
  - Replicate API token
35
35
 
36
- Setup:
36
+ Install from npm and configure settings:
37
37
 
38
38
  ```bash
39
- npm install
40
- cp .env.example .env
39
+ npm install -g @telepat/rilo
40
+ rilo settings
41
+ rilo --project demo --story-file ./story.txt
41
42
  ```
42
43
 
43
- Set required environment variables in .env, **or use the interactive settings command** (see below):
44
+ If you prefer environment variables instead of the interactive settings menu:
44
45
 
45
46
  ```bash
46
- RILO_REPLICATE_API_TOKEN=your-token
47
- RILO_API_BEARER_TOKEN=your-api-bearer-token
47
+ export RILO_REPLICATE_API_TOKEN=your-token
48
+ export RILO_API_BEARER_TOKEN=your-api-bearer-token
48
49
  ```
49
50
 
50
- Run the full local stack:
51
-
52
- ```bash
53
- npm run dev:all
54
- ```
51
+ ## Contributor Workflow
55
52
 
56
- Run a CLI generation:
53
+ For development in this repository:
57
54
 
58
55
  ```bash
59
- rilo --project demo --story-file ./story.txt
56
+ npm install
57
+ cp .env.example .env
58
+ npm run dev:all
60
59
  ```
61
60
 
62
61
  ## Settings
@@ -67,7 +66,7 @@ Configure rilo interactively without editing files:
67
66
  rilo settings
68
67
  ```
69
68
 
70
- For local development in this repository:
69
+ If you're working from a checked-out repository instead of an installed package:
71
70
 
72
71
  ```bash
73
72
  npm run dev -- settings
@@ -95,7 +94,7 @@ npm install -g @telepat/rilo
95
94
  rilo --help
96
95
  ```
97
96
 
98
- Or without global install:
97
+ If you prefer not to install globally:
99
98
 
100
99
  ```bash
101
100
  npx @telepat/rilo --help
@@ -103,6 +102,22 @@ npx @telepat/rilo --help
103
102
 
104
103
  ## CLI Quick Reference
105
104
 
105
+ ### Launch dashboard preview
106
+
107
+ ```bash
108
+ rilo preview
109
+ ```
110
+
111
+ Starts local API + worker + dashboard on `127.0.0.1:3000` and opens the browser.
112
+
113
+ For container/tunnel scenarios (unsafe unauthenticated access):
114
+
115
+ ```bash
116
+ rilo preview --expose --unsafe-no-auth --host 0.0.0.0 --port 3000
117
+ ```
118
+
119
+ Use exposed mode only on trusted networks or isolated environments.
120
+
106
121
  ### Generate a video from a story
107
122
 
108
123
  ```bash
@@ -150,7 +165,7 @@ rilo --version # Show version
150
165
  |--------|---------|
151
166
  | **Global install** | `rilo --project <name> --story-file <path>` |
152
167
  | **No install (npx)** | `npx @telepat/rilo --project <name> --story-file <path>` |
153
- | **Local dev** | `npm run dev -- --project <name> --story-file <path>` |
168
+ | **Contributor dev** | `npm run dev -- --project <name> --story-file <path>` |
154
169
 
155
170
  ### Key flags
156
171