An open API service indexing awesome lists of open source software.

https://github.com/infraz/mmdb-cli

MMDB CLI
https://github.com/infraz/mmdb-cli

cli geo geolocation hacktoberfest infraz mmdb mmdb-cli

Last synced: about 1 month ago
JSON representation

MMDB CLI

Awesome Lists containing this project

README

          

# MMDB CLI

![GitHub License](https://img.shields.io/github/license/InfraZ/mmdb-cli)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/InfraZ/mmdb-cli/release.yaml)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/InfraZ/mmdb-cli/tests.yaml)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FInfraZ%2Fmmdb-cli.svg?type=shield&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2FInfraZ%2Fmmdb-cli?ref=badge_shield&issueType=license)

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

| Platform | Architecture | Supported |
| :------: | :-------------------: | :-------: |
| Linux | amd64 | ✅ |
| Linux | arm64 | ✅ |
| macOS | amd64 | ✅ |
| macOS | arm64 (Apple Silicon) | ✅ |
| FreeBSD | amd64 | ✅ |
| FreeBSD | arm64 | ✅ |
| Windows | amd64 | ✅ |
| Windows | arm64 | ✅ |

## Documentation

The official documentation for MMDB CLI is available on the
[InfraZ Documentation Website](https://docs.infraz.io/docs/mmdb-cli).

> [!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](https://github.com/InfraZ/homebrew-tap):

```bash
brew tap 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](https://github.com/InfraZ/mmdb-cli/releases).

```bash
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.

```bash
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.

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

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

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

5. Verify the installation by running the following command.

```bash
mmdb-cli --version
```

## Development

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

```bash
go mod download -x # Download dependencies
```

To build the project, run the following command:

```bash
go build -o mmdb-cli # Build the project
```

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

```bash
./mmdb-cli # Run the project
```

## License

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

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FInfraZ%2Fmmdb-cli.svg?type=large&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2FInfraZ%2Fmmdb-cli?ref=badge_large&issueType=license)