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.3.tar.gz (12.3 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.3-py3-none-any.whl (22.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for cppref-0.1.3.tar.gz
Algorithm Hash digest
SHA256 9287437d955cb0e6efe665446aa608b4408b9ded1c3b652ba205506f7d114d02
MD5 862e2621200e067eb84d0e165253f7f7
BLAKE2b-256 25effba0d18c22c4c52460881ce34ca3f05bf4c97a344f044a11b3e09c45d682

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for cppref-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 9a81584648be821f2373cf260fb8e52eeb8157ca300a9b35a583f837f54c0307
MD5 0715279f8ba2a3a6d6963d4e7b810267
BLAKE2b-256 e9922173bc4ccfa291a58f09ece0f80b85bbad46fe346606e95fcd04eb8ff2b6

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