Skip to content

basic-workflow.md

Latest commit

 

History

History
73 lines (51 loc) · 1.88 KB

basic-workflow.md

File metadata and controls

73 lines (51 loc) · 1.88 KB
Raw

Basic workflow

zim download simple-wiki
zim index simple-wiki
zim search "photosynthesis" simple-wiki
zim read simple-wiki "Photosynthesis"

Download

The four maintained aliases are simple-wiki, wiktionary, stackoverflow, and ted:

zim download simple-wiki

Use zim catalog search <query> to find other archives, then pass a normalized catalog URL to zim download.

Index

zim index simple-wiki

Indexing creates SQLite full-text data and semantic vectors by default. Skip semantic vectors when you need only keyword search:

zim index --no-semantic simple-wiki

Search

zim search "photosynthesis" simple-wiki
zim search --semantic "how plants make food" simple-wiki
zim search --json "plant energy" simple-wiki

Omit the archive to search every indexed ZIM file. Use --non-interactive for plain terminal output in scripts. The configuration value search.max_results, rather than a CLI flag, controls the result limit.

Read and browse

zim read simple-wiki "Photosynthesis"
zim serve simple-wiki

serve uses the configured server host and port; the defaults produce http://localhost:8080.

Manage the library

zim library
zim info simple-wiki
zim list simple-wiki
zim remove simple-wiki

The default library is ~/.cache/zim. You can change it with zim config create or ZIM_LIBRARY_PATH.

Troubleshooting

  • If semantic model initialization fails, run zim index --no-semantic <archive>.
  • If an archive name is ambiguous, use its exact filename, library number, or direct path.
  • If no SQLite results are available, create or rebuild the index with zim index <archive> or zim index --force <archive>.

Related documentation