CLICommands
lore
snug lore <COMMAND>Lore - Interactive story runtime: sessions, player commands, checkpoints.
Subcommands
| Command | What it does |
|---|---|
create | Create a session for a published story |
dev | Create a dev session from inline compiled lore output |
list | List your sessions |
get | Get a session by ID |
delete | Delete (stop) a session |
command | Send a fire-and-forget command to a running session |
step | Advance a running session one step and print the resulting story events |
checkpoint | Save a checkpoint for a session |
checkpoints | List the checkpoints saved for a session |
load-checkpoint | Load a checkpoint's data for a session |
Run snug lore <command> --help for that command's own options.
The global options apply everywhere.
Examples
snug lore create -u universe-1 -s story-1 --auto-start
snug lore create -u universe-1 -s story-1 -c before_boss -i '{"difficulty":"hard"}'
snug lore dev -o @compiled.json --auto-start
snug lore list
snug lore get <session_id>
snug lore delete <session_id> -f
snug lore step <session_id>
snug lore step <session_id> -e ready -d '{"index":1}'
snug lore command <session_id> -e stop
snug lore checkpoint <session_id> -n save1 -d '{"position":42}'
snug lore checkpoints <session_id>
snug lore load-checkpoint <session_id> -n save1Next
- lore guide - what the service does and when to reach for it.
- API reference - every endpoint these commands call.
- CLI reference - global options, output modes, and exit codes.