Skip to content

Storage

storage

Defines the host-storage reset for the launcher

Deletes the platformdirs folder Mirumoji writes to on the host, so a user can wipe their local data without hunting for it. Docker named volumes are out of scope (use down --volumes for those)

ResetStep dataclass

The outcome of clearing one storage target

Attributes:

Name Type Description
label str

Human-readable name of the target

status str

One of removed, absent, or failed

detail str

The OS error message when status is failed

reset_storage(*, keep_config=False, keep_logs=False)

Deletes Mirumoji's host storage folder

Removes the media, database (and its sidecars), source checkout, and cache. The config (env keys) and logs go too unless kept. Docker named volumes are not touched

Log Handle
  • The launcher holds launcher.log open, so logging is torn down before the logs directory is removed

  • This releases the file so the folder is deletable on Windows

Best Effort
  • Each target is cleared independently

  • A locked path (such as the database while a native server runs) is reported as failed rather than aborting the reset

Parameters:

Name Type Description Default
keep_config bool

Preserve the managed config file when True

False
keep_logs bool

Preserve the logs directory when True

False

Returns:

Type Description
list[ResetStep]

One ResetStep per target, in the order attempted