Skip to content

A package index for Go packages with custom import path support.

License

Notifications You must be signed in to change notification settings

cipherdothost/pkgdex

Pkgdex

A screenshot of the Pkgdex homepage showing two Go packages and their metadata.

Pkgdex is a powerful, yet simple, self-hosted service that provides both a searchable index for your Go packages and vanity import path handling.

Features

  • Full-text search across packages.
  • Vanity import path support.
  • Download statistics.
  • RSS feed for updates.
  • XML sitemap generation.
  • Wayback Machine integration.

A live version of the index is available at https://go.cipher.host/.

Installation

From source

First install the dependencies:

  • Go 1.24 or above.
  • make.
  • npm.
  • scdoc.

Clone the repository, switch to the latest stable tag, then compile, and install:

git clone 'https://github.com/cipherdothost/pkgdex.git'
cd 'pkgdex'
git checkout 'v1.0.0'
npm install
make
sudo make install

Usage

Contributing

Anyone can help make pkgdex better. Check out the contribution guidelines and the development instructions for more information.


The work in this repository complies with the REUSE specification. While the default license is EUPL-1.2, individual files may be licensed differently.

Please see the individual files for details and the LICENSES directory for a full list of licenses used in this repository.