archwiki-rs

Read a page from the ArchWiki

$ archwiki-rs read-page [page_title]

$ archwiki-rs read-page [page_title] --format [plain-text|markdown|html]

$ archwiki-rs search "[search_text]" --text-search

$ archwiki-rs local-wiki /[path/to/local_wiki] --format [plain-text|markdown|html]

archwiki-rs [QUERY] [-h | --help] [-V | --version] [--cache-dir DIR] [-c | --color WHEN] [--config FILE] [-i | --ignore-case] [--no-cache] [-o | --open] [--pager PAGER] [-p | --preview] [--search-section]

-h, --help
    Print help information

-V, --version
    Print version information

--cache-dir DIR
    Set cache directory (default: ~/.cache/archwiki-rs)

-c, --color WHEN
    Control colors: always, auto, never (default: auto)

--config FILE
    Set config file path (default: ~/.config/archwiki-rs/config.toml)

-i, --ignore-case
    Ignore case in searches (default)

--no-cache
    Disable cache; forces online fetch

-o, --open
    Open top result in default browser

--pager PAGER
    Use custom pager (default: less -R)

-p, --preview
    Show page preview in results

--search-section
    Include section names in search

archwiki-rs is a fast, feature-rich command-line tool written in Rust for searching the Arch Linux Wiki directly from the terminal. It supports fuzzy matching, offline access via cached data, previews of search results, and opening pages in your default browser.

Key features include case-insensitive searches, section-specific querying, customizable caching, and pager support for long outputs. Upon first run, it downloads a local copy of the wiki pages (around 100MB), enabling instant searches without internet. Ideal for Arch users needing quick wiki reference during troubleshooting or learning.

It's lightweight, blazing fast due to Rust's performance, and available via AUR or Cargo. Configuration allows tweaking colors, preview lengths, and cache locations for personalized use.

Requires initial internet for cache download (~100MB). Not in core repos; install via AUR (yay -S archwiki-rs) or Cargo. Cache updates manually via --no-cache. Fuzzy search may miss exact terms.

Arch: AUR helpers like yay/paru. Others: cargo install archwiki-rs.

Edit ~/.config/archwiki-rs/config.toml for preview_length, open_browser, etc.

Developed in 2022 by Rust enthusiasts as a faster alternative to web searches. Hosted on GitHub (Peltoche/archwiki-rs), gained popularity via AUR. Actively maintained with v0.6+ adding previews and config.toml support.

man(1), apropos(1), tldr(1)