Skip to main content
This guide will get you up and running with Zeal in just a few minutes. You’ll learn how to download documentation, search for APIs, and use Zeal from the command line.

​
Prerequisites

Before starting, make sure you have Zeal installed on your system.

Install Zeal

Follow the installation guide for your platform

​
Getting Started

1

Launch Zeal

Start Zeal from your applications menu, desktop shortcut, or command line:
zeal
When you first launch Zeal, you’ll see an empty window with no documentation available.
2

Open the Docsets dialog

Navigate to Tools → Docsets in the menu bar, or press Ctrl+, (Cmd+, on macOS) to open the Docsets dialog.Docsets dialog
The Docsets dialog has two tabs: Installed (docsets you’ve already downloaded) and Available (all available docsets).
3

Download your first docsets

In the Available tab:
  1. Browse or search for the documentation you need (e.g., “Python”, “JavaScript”, “C++”)
  2. Select the checkbox next to each docset you want
  3. Click the Download button
Popular docsets to start with:
  • Python — Python standard library
  • JavaScript — MDN JavaScript reference
  • HTML — MDN HTML reference
  • CSS — MDN CSS reference
  • Node.js — Node.js API documentation
You can download multiple docsets at once. Zeal will download them in parallel.
4

Wait for downloads to complete

Zeal will download and install the selected docsets. Progress is shown in the dialog.Once complete, close the Docsets dialog. Your documentation is now available offline!

​
Searching Documentation

Now that you have docsets installed, let’s learn how to search them. Click the search bar at the top of the Zeal window and start typing: 
array
Zeal will instantly show results from all installed docsets, including functions, classes, and topics related to “array”. Search results

​
Searching Specific Docsets

To limit your search to specific docsets, use the : prefix: 
python:pprint
This searches only the Python docset for “pprint”. 
# Search Python documentation
python:list

# Search JavaScript documentation  
javascript:array.map

# Search C++ documentation
cpp:vector
Zeal supports fuzzy matching, so you don’t need to type exact names: 
js:arrmap    → finds Array.map in JavaScript
py:strfmt    → finds str.format in Python
cpp:vecpush  → finds vector::push_back in C++

​
Command Line Usage

You can launch Zeal with a search query directly from the command line: 
# Search for a specific function
zeal python:pprint

# General search
zeal "array methods"

# Start minimized
zeal --minimized

​
Protocol Handlers

Zeal supports dash:// and dash-plugin:// URL schemes for IDE integration: 
# Open Zeal with a query
open dash://python:pprint

# With advanced options
open "dash-plugin://keys=python&query=pprint"
On Windows, protocol handlers must be registered first using zeal.exe --register.

​
Working with Multiple Pages

Zeal supports tabbed browsing for documentation:
  • Open in new tab: Right-click a search result → Open in New Tab
  • Switch tabs: Use the tab bar at the top of the content area
  • Close tab: Click the × on the tab or press Ctrl+W (Cmd+W on macOS)
Keep multiple reference pages open while coding. For example, have Python’s str methods in one tab and datetime formatting in another.

​
Global Keyboard Shortcut

Set up a global keyboard shortcut to summon Zeal from anywhere:
1

Open Settings

Navigate to Tools → Settings or press Ctrl+, (Cmd+, on macOS).
2

Configure shortcut

In the Shortcuts section:
  1. Find Show/Hide Zeal
  2. Click the shortcut field
  3. Press your desired key combination (e.g., Alt+Space)
  4. Click OK to save
3

Test it

Minimize Zeal and press your configured shortcut. Zeal should appear instantly!
Make sure your global shortcut doesn’t conflict with existing system or application shortcuts.

​
Practical Example: Python Development

Let’s walk through a real-world example of using Zeal while coding.
1

Download Python docsets

Open Tools → Docsets and download:
  • Python (Python standard library)
  • Django (if you use Django)
  • NumPy (if you use NumPy)
2

Search for documentation

While writing Python code, you need to know how to format a datetime:
python:datetime.strftime
Zeal instantly shows the strftime() documentation with format codes.
3

Keep it accessible

Set up a global shortcut (e.g., Alt+Space) so you can quickly look up documentation without leaving your code editor.

​
Updating Docsets

Documentation gets updated regularly. To update your installed docsets:
1

Open Docsets dialog

Navigate to Tools → Docsets.
2

Check for updates

Switch to the Installed tab. Docsets with available updates will be highlighted.
3

Update

Click Update All to update all docsets, or select specific docsets and click Update Selected.
Zeal periodically checks for docset updates in the background. Check the Available tab to see when the docset list was last refreshed.

​
IDE Integration

Integrate Zeal with your favorite IDE or text editor:

VS Code

Install the Dash extension and configure it to use Zeal.

Sublime Text

Use the DashDoc package and set Zeal as the documentation viewer.

Vim/Neovim

Use zeavim.vim plugin for seamless integration.

Emacs

Use the zeal-at-point package.
Learn more about IDE integration in the Protocol Handlers guide.

​
Tips and Tricks

When viewing search results, you can filter by type (e.g., Classes, Functions, Methods) using the sidebar on the left.
Zeal automatically detects your system theme and switches between light and dark modes. You can also manually set your preferred theme in Tools → Settings → Appearance.
On Windows, use the portable version to run Zeal from a USB drive without installation.
Change where Zeal stores docsets in Tools → Settings → Docsets → Docset Storage Path. Useful for storing docsets on a different drive.

​
Next Steps

Now that you’re familiar with the basics, explore these topics:

Advanced Search

Master advanced search techniques and filters

Keyboard Shortcuts

Learn all keyboard shortcuts for efficient navigation

Customization

Customize Zeal’s appearance and behavior

Creating Docsets

Create custom docsets for your own documentation

​
Common Use Cases

​
Web Development

# Download essential web development docsets
- HTML
- CSS  
- JavaScript
- TypeScript
- React
- Vue.js
- Node.js

​
Python Development

# Download Python-related docsets
- Python
- Django
- Flask
- NumPy
- Pandas
- SciPy

​
Systems Programming

# Download systems programming docsets
- C
- C++
- Rust
- Go
- POSIX

​
Mobile Development

# Download mobile development docsets
- Android
- iOS (Swift/Objective-C)
- Flutter
- React Native
Not sure which docsets to download? Start with the languages and frameworks you use most, then add more as needed. You can always download additional docsets later.

​
Getting Help

If you run into issues or have questions:

User Guide

Read the comprehensive user guide

GitHub Discussions

Ask questions and share ideas

Report Issues

Report bugs and request features

IRC Channel

Chat with the community

Build docs developers (and LLMs) love

Get started for freeTalk to us