Skip to main content

Refer to the cppreference with this cli!

Project description

cppref

A cli cpp manual pages for Linux/MacOS!

Demostration

✨ Features

  • 📁 XDG base directories support.
  • 🔎 Interactive lookup powered by fzf.
  • 💻 Properly rendered contents.
  • 💪 Async download for improved performance.
  • ⏳ Pretty progress bar for downloading.

⚡️ Requirements

  • fzf for interactive lookup.
  • playwright chromium driver for subcommands fetch and cache, i.e., not offline mode.

🚀 Getting Started

uv tools install cppref

Downloading manual page database.

dbdir="${XDG_DATA_HOME}:-$HOME/.local/share/cppref"
mkdir -p "$dbdir"
wget -O "$dbdir/index.db" https://github.com/ZachVec/cppref/releases/latest/download/index.db

Downloading processed manual pages if cppref is going to be used in offline mode.

man3dir="${XDG_DATA_HOME:-$HOME/.local/share}/man/man3"
mkdir -p "$man3dir"
wget -O /tmp/man3_archive.tar.gz https://github.com/ZachVec/cppref/releases/latest/download/man3_archive.tar.gz
tar xzf /tmp/man3_archive.tar.gz -C "$man3dir"

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cppref-0.1.1.tar.gz (10.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cppref-0.1.1-py3-none-any.whl (19.9 kB view details)

Uploaded Python 3

File details

Details for the file cppref-0.1.1.tar.gz.

File metadata

  • Download URL: cppref-0.1.1.tar.gz
  • Upload date:
  • Size: 10.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.1

File hashes

Hashes for cppref-0.1.1.tar.gz
Algorithm Hash digest
SHA256 72e0e5e00e1ab7fe6793a5300b8307f7ef2f661349a7899f636ad9b6c61c3967
MD5 56271328b630492891660289157072a1
BLAKE2b-256 0fc68eb16c346acb2661d42322efabc7d69e8b1aad35befdfc9c354ef6a9cf52

See more details on using hashes here.

File details

Details for the file cppref-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: cppref-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 19.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.1

File hashes

Hashes for cppref-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 95072e2cd07d83baf3ee10e61fa978403cfa31b5151d7a409376a281ee3c1967
MD5 3d1a24c14cf7850b3a83493c7bf0f828
BLAKE2b-256 d08b25f9c1631d12de24fca6e4009083fb691c7ea914737fbf7e904df394f684

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page