mmdb-cli

MMDB CLI

MMDB CLI is a command-line open-source project, developed to simplify working with MMDB files. It is a command-line tool that allows you to generate, modify, export, and inspect MMDB files, among other functionalities.

Supported Platforms

Documentation

The official documentation for MMDB CLI is available on the InfraZ Documentation Website.

[!TIP] We recommend reading the documentation to get a better understanding of the MMDB CLI and its functionalities.

Installation (Homebrew)

On macOS, you can install MMDB CLI via the InfraZ Homebrew tap:

brew tap infraz/tap
brew trust infraz/tap
brew install infraz/tap/mmdb-cli

Installation (Pre-compiled Binaries)

Linux and macOS

1. Choose the version and platform you want to install from the GitHub releases page.

   export MMDB_CLI_VERSION=0.5.0
   export MMDB_CLI_PLATFORM=linux_amd64
   

2. Download the MMDB CLI tarball using curl, wget, or any other tool.

   curl -LO "https://github.com/InfraZ/mmdb-cli/releases/download/v${MMDB_CLI_VERSION}/mmdb-cli_${MMDB_CLI_VERSION}_${MMDB_CLI_PLATFORM}.tar.gz"
   

3. Extract the downloaded tarball.

   tar -xzf mmdb-cli_${MMDB_CLI_VERSION}_${MMDB_CLI_PLATFORM}.tar.gz
   

4. Move the extracted binary file to a directory in your PATH.

   sudo mv mmdb-cli /usr/local/bin/
   

5. Verify the installation by running the following command.

   mmdb-cli --version
   

Container Image

Pre-built multi-arch images (linux/amd64, linux/arm64) are published to the GitHub Container Registry:

The image ENTRYPOINT is mmdb-cli and the working directory is /data, so mount your files there:

# Inspect a database
docker run --rm -v "$PWD:/data" ghcr.io/infraz/mmdb-cli:latest \
  metadata -i GeoLite2-City.mmdb

# Generate a database from a JSON dataset (writes back to the host)
docker run --rm -v "$PWD:/data" --user "$(id -u):$(id -g)" \
  ghcr.io/infraz/mmdb-cli:latest \
  generate -i dataset.json -o result.mmdb

The container runs as a non-root user (UID 1000). When writing files to a bind mount, add --user "$(id -u):$(id -g)" so the output is owned by you.

Building the image locally

docker build -t mmdb-cli --build-arg VERSION=v0.0.0-dev .
docker run --rm mmdb-cli version

Development

To get started, clone the repository and run the following commands to download the dependencies:

go mod download -x # Download dependencies

To build the project, run the following command:

go build -o mmdb-cli # Build the project

Then, you can run the project with the following command:

./mmdb-cli # Run the project

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.