library-management.md

Library management

zim library
zim download simple-wiki
zim info simple-wiki

The configured library stores local .zim archives. Its default path is ~/.cache/zim.

Add archives

Download a maintained alias:

zim download simple-wiki
zim download wiktionary
zim download stackoverflow
zim download ted

Find other current artifacts through the Kiwix catalog:

zim catalog search wikipedia
zim download <catalog-zim-url>

You may also copy an existing archive into the library:

cp ./archives/example.zim ~/.cache/zim/

Select archives

zim library
zim info 1
zim list simple-wiki
zim serve simple-wiki

Commands accept a current library number, exact filename, name without .zim, or an unambiguous fragment. Read-only commands also accept a direct path. If a fragment matches multiple files, use a more specific name or the displayed number.

Search a specific archive

zim index simple-wiki
zim search "quantum mechanics" simple-wiki

Omit the archive argument to search all indexed libraries:

zim search "quantum mechanics"

Remove archives

zim library
zim remove 1

Removal is permanent, is limited to archives inside the configured library, and also removes matching derived SQLite index rows.

Change the library location

zim config create
zim config show

Set library.path in ~/.config/zim/config.yaml or export ZIM_LIBRARY_PATH. See configuration.