The axiom command line¶
Installing axiomai-engine provides the axiom command (also reachable as
python -m axiom.cli). Run axiom --help or axiom <command> --help for the
authoritative usage; this page is the annotated tour.
Wherever a command takes a universe argument, it accepts a .db file, a
source folder (compiled on the fly when needed) or a .axiom archive.
Playing¶
axiom play¶
Play a universe interactively in the terminal:
$ axiom play MyWorld.db --name Alice --difficulty Normal
Option |
Effect |
|---|---|
|
Resume an existing save. |
|
Force a new game. |
|
Player name for a new game (default |
|
Game mode for a new game. |
|
LLM sampling settings. |
|
Narration length. |
The universe path is also searched in ~/AxiomAI/universes/.
Saves¶
All save-* commands operate on a universe and a save identifier. See
Saves, rewind and sharing for the concepts.
axiom save-show¶
Inspect a save’s state, optionally at a past point (--turn N or
--minute M):
$ axiom save-show MyWorld.db <save_id> --turn 12
axiom save-export / axiom save-import¶
Round-trip a save through an editable save_state.toml:
$ axiom save-export MyWorld.db <save_id> state.toml
$ axiom save-import MyWorld.db state.toml [--name Alice]
axiom save-fork¶
Fork a save into a new one, truncating the journal at a point (--turn /
--minute) — an alternate timeline:
$ axiom save-fork MyWorld.db <save_id> --turn 10 --name "Alice (what if)"
axiom save-edit¶
Fix an existing save in place by applying a correction TOML (stat patches
under [state.<entity_id>], plus [[inventory]] and [[modifiers]]
entries); --turn targets a past point:
$ axiom save-edit MyWorld.db <save_id> patch.toml
axiom save-pack / axiom save-unpack¶
Share a single save as a .axiomsave archive:
$ axiom save-pack MyWorld.db <save_id> alice.axiomsave
$ axiom save-unpack MyWorld.db alice.axiomsave