Reportingwikinoteseditornotebooktext-editororganizer

Zim

Zim is a graphical text editor based on wiki technologies used to maintain collections of wiki pages. It stores data in plain text files with wiki formatting and supports plugins for additional functionality.

Description

Zim is a desktop wiki editor designed for organizing notes, tasks, and documents in a hierarchical folder structure. Each page supports links to other pages, simple formatting, inline images, and attachments. Creating new pages is intuitive by simply linking to a nonexistent page name. All content is saved in plain text files using wiki markup, ensuring portability and version control compatibility.

Zim is ideal for various personal and professional use cases including archiving notes, maintaining daily or weekly journals, taking meeting or lecture notes, organizing task lists, drafting blog entries and emails, and brainstorming sessions. Its plugin system extends functionality with features like task list management, equation editing, tray icons, and version control integration.

The tool operates through a graphical interface by default but offers command-line modes for server operation, exporting, importing, searching, and indexing notebooks. This flexibility makes it suitable for both interactive use and automated workflows.

How It Works

Zim stores wiki pages as plain text files in a folder hierarchy mimicking an outliner structure, using wiki formatting for links, formatting, and images. Pages reference each other via links, with attachments stored alongside. Plugins extend core functionality by processing wiki markup for tasks, equations, etc. Command-line modes handle specific operations: --server runs a web interface on port 8080 by default, --export converts wiki content to formats like HTML, --import parses external files into wiki format, --search queries page content, and --index builds searchable indexes.

Installation

bash
sudo apt install zim

Flags

--guirun the editor (this is the default)
--serverrun the web server
--exportexport to a different format
--importimport one or more files into a notebook
--searchrun a search query on a notebook
--indexbuild an index for a notebook
--plugincall a specific plugin function
--listshow the list with notebooks instead of opening the default notebook
--geometrywindow size and position as WxH+X+Y
--portport to use (defaults to 8080)
--outputoutput directory (mandatory option)
-ooutput directory (mandatory option)
--formatformat to use (defaults to 'html')

Examples

Open the default notebook or specified notebook and page in the graphical editor (default behavior)
zim [NOTEBOOK [PAGE_LINK]]
Explicitly run the graphical editor with optional notebook and page
zim --gui [NOTEBOOK [PAGE_LINK]]
Run the web server for accessing the notebook via browser on port 8080
zim --server [NOTEBOOK]
Export notebook or page to another format like HTML, requires --output directory
zim --export [OPTIONS] NOTEBOOK [PAGE]
Import one or more files into a notebook page as wiki content
zim --import [OPTIONS] NOTEBOOK PAGE FILES
Search for a query within the specified notebook
zim --search [OPTIONS] NOTEBOOK QUERY
Build or rebuild the search index for a notebook
zim --index [OPTIONS] NOTEBOOK
Open the complete manual documentation
zim --manual
Updated 2026-04-16kali.org ↗