Skip to content

overview.md

Latest commit

 

History

History
73 lines (53 loc) · 2.8 KB

overview.md

File metadata and controls

73 lines (53 loc) · 2.8 KB
Raw

Command Overview

All ZIM Reader CLI commands organized by category.

Library Management

Commands for managing your ZIM file library.

Command Description Detailed Docs
zim library List all ZIM files in your library library.md
zim download Download ZIM files to your library download.md
zim remove Remove a ZIM file from your library remove.md

Content Access

Commands for accessing and reading ZIM file content.

Command Description Detailed Docs
zim info Display ZIM file metadata and statistics info.md
zim list List all articles in a ZIM file list.md
zim read Read a specific article from a ZIM file read.md
zim extract Extract article content to stdout or files extract.md

Search Operations

Commands for searching within ZIM files.

Command Description Detailed Docs
zim search Search articles using full-text search search.md
zim index Create search indexes for fast retrieval index.md
zim popularity Import an explicit rankings TSV into an archive's index index.md

Server Operations

Commands for serving ZIM content over HTTP.

Command Description Detailed Docs
zim serve Start HTTP server to browse ZIM file content serve.md
zim ui Deprecated alias for zim serve; retained for compatibility serve.md

Quick Reference

# Library management
zim library                    # List library contents
zim download <alias-or-url>   # Download ZIM file
zim remove <name>             # Remove from library

# Content access
zim info <file>               # Show file metadata
zim list <file>               # List all articles
zim read <file> <article>      # Read specific article
zim extract <file> <article>  # Extract article content

# Search operations
zim search <query> [file]      # Search articles
zim index <file>              # Create search index
zim popularity <file> <tsv>  # Import popularity rankings

# Server operations
zim serve <file>              # Start HTTP server

See Also