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

Install by uv

uv tool 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.2.tar.gz (10.8 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.2-py3-none-any.whl (19.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for cppref-0.1.2.tar.gz
Algorithm Hash digest
SHA256 ef31af7d2d0ad4c98daa8e915b6d8dbdaab62141ba7c843936641215a906b54b
MD5 61c4550ce2191acda77b80ee8c9454c7
BLAKE2b-256 0d696a988a8f27db2855d5bae4e3c74adb3846b021d533e2f988dad516daf4e3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cppref-0.1.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0dbee59731658f2321e5ee2172b9a6da7d01a0f321ad80fd35b3c57e93f2e662
MD5 777b1ce6941dfb294aa6811a08609eb6
BLAKE2b-256 a34cb6998393de637639bc528b49027376eda5610002a8daabc5ddc81bc883e8

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