Products

CLI Tool

Access and manage documentation directly from your terminal with our powerful command-line interface.

Overview

The Zudoku CLI is a Go-based tool that brings documentation to your terminal. Search, browse, and download documentation without leaving your development environment. Perfect for terminal enthusiasts and automation workflows.

Key Features

⚡ Lightning Fast

Written in Go for maximum performance
Instant search results
Parallel downloads
Minimal resource usage

🔍 Powerful Search

Full-text search across all documentation
Filter by category, tags, and more
Fuzzy matching
Regex support

📥 Offline Access

Download entire documentation sites
Incremental sync
Smart caching
Version management

🎨 Beautiful Output

Colored terminal output
Formatted tables
Progress bars and spinners
Markdown rendering in terminal

🔧 Automation Ready

JSON and YAML output
Easy to script
CI/CD integration
Pipeline friendly

🌐 Multi-Provider

Support for all Zudoku domains
Switch between documentation sites easily
Multiple configurations
Environment variable support

Installation

Homebrew (macOS/Linux)

Code
 
brew tap zuplo/zudoku
brew install zudoku-cli

Go Install

Code
 
go install github.com/zuplo/zudoku-cli@latest

Download Binary

Download the latest release for your platform:

Docker

Code
 
docker pull zudoku/cli:latest
docker run zudoku/cli search "authentication"

Quick Start

Configuration

Create a config file at ~/.zudoku.yaml:


Code
 
domain: yourdomain.com
format: table
verbose: false

Or use environment variables:

Code
 
export ZUDOKU_DOMAIN=yourdomain.com
export ZUDOKU_FORMAT=table

Basic Usage

Code
 
# Search documentation
zudoku search "authentication"

# Get a specific page
zudoku get /docs/quickstart

# List all pages
zudoku list

# Download for offline access
zudoku sync ./docs

Commands

search

Search through documentation content.

Code
 
# Basic search
zudoku search "API authentication"

# With filters
zudoku search "tutorial" --category=guides --limit=20

# With tags
zudoku search "setup" --tags=beginner,quickstart

# JSON output
zudoku search "api" --format=json

Options:

-l, --limit - Maximum results (default: 10)
-c, --category - Filter by category
-t, --tags - Filter by tags (comma-separated)

get

Retrieve a specific documentation page.

Code
 
# View in terminal
zudoku get /docs/api-reference

# Save to file
zudoku get /docs/quickstart --output=quickstart.md

# Get as HTML
zudoku get /docs/guides --format=html

# Get as JSON
zudoku get /docs/api --format=json

Options:

-f, --format - Output format (markdown, html, json)
-o, --output - Save to file instead of stdout

list

List all available documentation pages.

Code
 
# List all pages
zudoku list

# Filter by category
zudoku list --category=guides

# JSON output for scripting
zudoku list --format=json | jq '.[] | .title'

# YAML output
zudoku list --format=yaml

Options:

-c, --category - Filter by category

sync

Download documentation for offline access.

Code
 
# Sync to directory
zudoku sync ./docs

# Force re-download
zudoku sync ./docs --force

# Sync with progress
zudoku sync ./docs --verbose

Options:

-f, --force - Force re-download all files
--verbose - Show detailed progress

config

Manage CLI configuration.

Code
 
# Show current config
zudoku config show

# Set domain
zudoku config set domain figmatofullstack.ai

# Set output format
zudoku config set format json

# Reset to defaults
zudoku config reset

Global Flags

Available for all commands:

--domain - Documentation domain
--config - Config file path (default: ~/.zudoku.yaml)
--format - Output format (table, json, yaml)
--verbose - Enable verbose output
--help - Show help

Output Formats

Table (Default)

Code
 
zudoku list

Code
 
+---------------------------+------------------+-----------+
| TITLE                     | PATH             | CATEGORY  |
+---------------------------+------------------+-----------+
| Quickstart Guide          | /docs/quickstart | getting-started |
| API Reference             | /docs/api        | reference |
| Authentication Guide      | /docs/auth       | guides    |
+---------------------------+------------------+-----------+

JSON

Code
 
zudoku list --format=json


Code
 
[
  {
    "title": "Quickstart Guide",
    "path": "/docs/quickstart",
    "category": "getting-started"
  }
]

YAML

Code
 
zudoku list --format=yaml


Code
 
- title: Quickstart Guide
  path: /docs/quickstart
  category: getting-started

Examples

Search and Open in Browser

Code
 
#!/bin/bash
result=$(zudoku search "$1" --format=json | jq -r '.[0].path')
open "https://yourdomain.com$result"

Daily Documentation Sync

Code
 
#!/bin/bash
# Add to crontab: 0 9 * * * /path/to/sync-docs.sh

zudoku sync ~/docs --verbose
echo "Documentation synced at $(date)" >> ~/docs/sync.log

Search with fzf

Code
 
zudoku list --format=json | \
  jq -r '.[] | "\(.path) - \(.title)"' | \
  fzf | \
  cut -d' ' -f1 | \
  xargs zudoku get

Export All Documentation

Code
 
#!/bin/bash
mkdir -p exports
zudoku list --format=json | jq -r '.[].path' | while read path; do
  filename=$(echo $path | tr '/' '-' | cut -c2-)
  zudoku get "$path" --output="exports/$filename.md"
done

Integration

CI/CD


Code
 
# GitHub Actions
- name: Check Documentation
  run: |
    zudoku sync ./docs
    zudoku search "API" --format=json > api-docs.json

Shell Scripts

Code
 
# Check if documentation exists
if zudoku get /docs/api-v2 > /dev/null 2>&1; then
  echo "API v2 docs available"
fi

Vim/Neovim

Code
 
" Search documentation from Vim
command! -nargs=1 ZudokuSearch !zudoku search <args>
nnoremap <leader>ds :ZudokuSearch

Performance

Startup Time: < 50ms
Search Speed: < 100ms average
Download Speed: 50+ MB/s
Memory Usage: < 10 MB

Testing

The CLI has 100% test coverage:

Code
 
# Run tests
go test ./...

# With coverage
go test -cover ./...

# Generate report
go test -coverprofile=coverage.out ./...
go tool cover -html=coverage.out

Support

Documentation: CLI Guide
GitHub: Issues & Features
Discord: Community Support
Email: cli@zudoku.dev

Contributing

We welcome contributions!

Code
 
# Clone repository
git clone https://github.com/zuplo/zudoku-cli.git
cd zudoku-cli

# Run tests
go test ./...

# Build
go build -o zudoku

See CONTRIBUTING.md for guidelines.

Get Started Now →

Edit this page

Last modified on February 14, 2026

Mobile App MCP Agents

Products

CLI Tool

Access and manage documentation directly from your terminal with our powerful command-line interface.

Overview

Key Features

⚡ Lightning Fast

Written in Go for maximum performance
Instant search results
Parallel downloads
Minimal resource usage

🔍 Powerful Search

Full-text search across all documentation
Filter by category, tags, and more
Fuzzy matching
Regex support

📥 Offline Access

Download entire documentation sites
Incremental sync
Smart caching
Version management

🎨 Beautiful Output

Colored terminal output
Formatted tables
Progress bars and spinners
Markdown rendering in terminal

🔧 Automation Ready

JSON and YAML output
Easy to script
CI/CD integration
Pipeline friendly

🌐 Multi-Provider

Support for all Zudoku domains
Switch between documentation sites easily
Multiple configurations
Environment variable support

Installation

Homebrew (macOS/Linux)

Code
 
brew tap zuplo/zudoku
brew install zudoku-cli

Go Install

Code
 
go install github.com/zuplo/zudoku-cli@latest

Download Binary

Download the latest release for your platform:

Docker

Code
 
docker pull zudoku/cli:latest
docker run zudoku/cli search "authentication"

Quick Start

Configuration

Create a config file at ~/.zudoku.yaml:


Code
 
domain: yourdomain.com
format: table
verbose: false

Or use environment variables:

Code
 
export ZUDOKU_DOMAIN=yourdomain.com
export ZUDOKU_FORMAT=table

Basic Usage

Code
 
# Search documentation
zudoku search "authentication"

# Get a specific page
zudoku get /docs/quickstart

# List all pages
zudoku list

# Download for offline access
zudoku sync ./docs

Commands

search

Search through documentation content.

Code
 
# Basic search
zudoku search "API authentication"

# With filters
zudoku search "tutorial" --category=guides --limit=20

# With tags
zudoku search "setup" --tags=beginner,quickstart

# JSON output
zudoku search "api" --format=json

Options:

-l, --limit - Maximum results (default: 10)
-c, --category - Filter by category
-t, --tags - Filter by tags (comma-separated)

get

Retrieve a specific documentation page.

Code
 
# View in terminal
zudoku get /docs/api-reference

# Save to file
zudoku get /docs/quickstart --output=quickstart.md

# Get as HTML
zudoku get /docs/guides --format=html

# Get as JSON
zudoku get /docs/api --format=json

Options:

-f, --format - Output format (markdown, html, json)
-o, --output - Save to file instead of stdout

list

List all available documentation pages.

Code
 
# List all pages
zudoku list

# Filter by category
zudoku list --category=guides

# JSON output for scripting
zudoku list --format=json | jq '.[] | .title'

# YAML output
zudoku list --format=yaml

Options:

-c, --category - Filter by category

sync

Download documentation for offline access.

Code
 
# Sync to directory
zudoku sync ./docs

# Force re-download
zudoku sync ./docs --force

# Sync with progress
zudoku sync ./docs --verbose

Options:

-f, --force - Force re-download all files
--verbose - Show detailed progress

config

Manage CLI configuration.

Code
 
# Show current config
zudoku config show

# Set domain
zudoku config set domain figmatofullstack.ai

# Set output format
zudoku config set format json

# Reset to defaults
zudoku config reset

Global Flags

Available for all commands:

--domain - Documentation domain
--config - Config file path (default: ~/.zudoku.yaml)
--format - Output format (table, json, yaml)
--verbose - Enable verbose output
--help - Show help

Output Formats

Table (Default)

Code
 
zudoku list

Code
 
+---------------------------+------------------+-----------+
| TITLE                     | PATH             | CATEGORY  |
+---------------------------+------------------+-----------+
| Quickstart Guide          | /docs/quickstart | getting-started |
| API Reference             | /docs/api        | reference |
| Authentication Guide      | /docs/auth       | guides    |
+---------------------------+------------------+-----------+

JSON

Code
 
zudoku list --format=json


Code
 
[
  {
    "title": "Quickstart Guide",
    "path": "/docs/quickstart",
    "category": "getting-started"
  }
]

YAML

Code
 
zudoku list --format=yaml


Code
 
- title: Quickstart Guide
  path: /docs/quickstart
  category: getting-started

Examples

Search and Open in Browser

Code
 
#!/bin/bash
result=$(zudoku search "$1" --format=json | jq -r '.[0].path')
open "https://yourdomain.com$result"

Daily Documentation Sync

Code
 
#!/bin/bash
# Add to crontab: 0 9 * * * /path/to/sync-docs.sh

zudoku sync ~/docs --verbose
echo "Documentation synced at $(date)" >> ~/docs/sync.log

Search with fzf

Code
 
zudoku list --format=json | \
  jq -r '.[] | "\(.path) - \(.title)"' | \
  fzf | \
  cut -d' ' -f1 | \
  xargs zudoku get

Export All Documentation

Code
 
#!/bin/bash
mkdir -p exports
zudoku list --format=json | jq -r '.[].path' | while read path; do
  filename=$(echo $path | tr '/' '-' | cut -c2-)
  zudoku get "$path" --output="exports/$filename.md"
done

Integration

CI/CD


Code
 
# GitHub Actions
- name: Check Documentation
  run: |
    zudoku sync ./docs
    zudoku search "API" --format=json > api-docs.json

Shell Scripts

Code
 
# Check if documentation exists
if zudoku get /docs/api-v2 > /dev/null 2>&1; then
  echo "API v2 docs available"
fi

Vim/Neovim

Code
 
" Search documentation from Vim
command! -nargs=1 ZudokuSearch !zudoku search <args>
nnoremap <leader>ds :ZudokuSearch

Performance

Startup Time: < 50ms
Search Speed: < 100ms average
Download Speed: 50+ MB/s
Memory Usage: < 10 MB

Testing

The CLI has 100% test coverage:

Code
 
# Run tests
go test ./...

# With coverage
go test -cover ./...

# Generate report
go test -coverprofile=coverage.out ./...
go tool cover -html=coverage.out

Support

Documentation: CLI Guide
GitHub: Issues & Features
Discord: Community Support
Email: cli@zudoku.dev

Contributing

We welcome contributions!

Code
 
# Clone repository
git clone https://github.com/zuplo/zudoku-cli.git
cd zudoku-cli

# Run tests
go test ./...

# Build
go build -o zudoku

See CONTRIBUTING.md for guidelines.

Get Started Now →

Edit this page

Last modified on February 14, 2026

Mobile App MCP Agents