You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: clarify security wording and document Gen mode
- Clarify LocalGPT.md security policy tampering detection
- Add Gen Mode (world generation) section with installation and usage
- Document localgpt-gen binary, scene import/export, and current limitations
Copy file name to clipboardExpand all lines: README.md
+24-2Lines changed: 24 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -167,7 +167,7 @@ localgpt sandbox test # Run smoke tests
167
167
168
168
### Signed Security Policy (LocalGPT.md)
169
169
170
-
Place a `LocalGPT.md` in your workspace to add custom rules (e.g. "never execute `rm -rf`"). The file is HMAC-SHA256 signed with a device-local key so the agent cannot tamper with it:
170
+
Place a `LocalGPT.md` in your workspace to add custom rules (e.g. "never execute `rm -rf`"). The file is HMAC-SHA256 signed with a device-local key so tampering will be detected:
171
171
172
172
```bash
173
173
localgpt md sign # Sign policy with device key
@@ -176,7 +176,7 @@ localgpt md status # Show security posture
176
176
localgpt md audit # View security event log
177
177
```
178
178
179
-
Verification runs at every session start. If the file is unsigned, missing, or tampered with, LocalGPT falls back to its hardcoded security suffix — it never operates with a compromised policy.
179
+
Verification runs at every session start. If the file is unsigned, missing, or tampered with, LocalGPT falls back to its hardcoded security suffix — it never operates with a compromised LocalGPT.md.
180
180
181
181
### Prompt Injection Defenses
182
182
@@ -282,6 +282,28 @@ LocalGPT includes a Proof of Concept for running the desktop Egui UI in the brow
282
282
283
283
See [`docs/egui-web-poc.md`](docs/egui-web-poc.md) for details on architecture, benefits, tradeoffs, and implementation.
284
284
285
+
## Gen Mode (World Generation)
286
+
287
+
`Gen` is currently shipped as a separate binary: `localgpt-gen` (not a `localgpt gen` subcommand).
288
+
289
+
```bash
290
+
# Install from this repo
291
+
cargo install --path crates/gen
292
+
293
+
# Start interactive Gen mode
294
+
localgpt-gen
295
+
296
+
# Start with an initial prompt
297
+
localgpt-gen "Create a low-poly forest scene with a path and warm lighting"
298
+
299
+
# Start from an existing glTF/GLB scene
300
+
localgpt-gen --scene ./scene.glb
301
+
```
302
+
303
+
`localgpt-gen` runs a Bevy window on the main thread and an agent loop in the background. It supports scene inspection, primitive spawning/modification, glTF load/export, and scene export to `.glb`.
304
+
305
+
Current limitation: screenshot capture is wired but still placeholder-level in the Bevy plugin (path is returned; full pixel capture is not finished yet).
306
+
285
307
## Blog
286
308
287
309
[Why I Built LocalGPT in 4 Nights](https://localgpt.app/blog/why-i-built-localgpt-in-4-nights) — the full story with commit-by-commit breakdown.
0 commit comments