2.4 KiB
Command reference
Epoch Forge operates on the current working directory; it does not yet search
parent directories. efo <command> --help is the authoritative syntax.
Repository and timeline
efo init [--force]creates.epochandepoch/0/epochinfo.json. Although--forceis accepted in 0.1.0, it currently has no effect and will not allow a non-empty directory.efo status [EPOCH_ID]shows an epoch summary, tags, and entity counts.efo epoch log [-c N]shows epochs around the current epoch.efo epoch nextcreates and checks out the next snapshot. It refuses while later snapshots exist.efo epoch switch ID_OR_TAGchecks out an existing snapshot without deleting later ones. Its currently accepted--forceflag has no effect.efo epoch summary TEXTandefo epoch tag TAGannotate the current epoch.efo epoch resetpermanently deletes every epoch after the current one.
epoch diff and epoch fsck are exposed in 0.1.0 but incomplete and currently
panic. They are current-release defects, not usable capabilities.
Entities
The built-in nouns are chr, town, event, calamity, and blocker:
efo <noun> add [NAME | --rng-name] [OPTIONS]
efo <noun> edit <NAME|@UUID> [OPTIONS]
efo <noun> show [NAME|@UUID]
efo <noun> diff <NAME|@UUID> [--epoch-id ID_OR_TAG]
efo <noun> del <NAME|@UUID>
Names match by prefix. @UUID is the stable form printed in detailed output;
short UUID prefixes are accepted. Avoid ambiguous prefixes.
Common add/edit options include --stats key:value ..., --position x,y,
--duration, --bounds, --effect, faction/reach/description/relationship
options, and prestige controls. edit --delta adds supplied stats rather than
replacing them. See nested help (for example efo chr add --help) for exact
syntax and values. Mutations write the current epoch immediately; staging does
not exist yet.
The top-level show command is currently demo output. Use <noun> show.
Generation and output
efo gen character|town|event|exotic|calamity|blocker prints generated content.
The first naming operation may unexpectedly create naming.json in the current
directory; removal of this side effect is planned.
Output is human-readable Unicode. Some 0.1.0 renderers emit ANSI colour when redirected and use optional Nerd Font glyphs; these are known accessibility issues. Stable JSON output is planned. A panic is always a bug.