A robust CLI tool framework for internal use.
Quick use the cli using nix flake
nix run github:omarcresp/amadeus-cli data/employees.json -- -amThe recommended way to build and develop this project is using Nix, which ensures reproducible builds and consistent development environments.
- Nix package manager with flakes enabled
- Linux operating system
# Build the production binary
nix build
# Run the cli directly
nix run
# Run tests
nix run .#test
# Enter development shell
nix shellIf you have direnv installed, the development environment will be automatically loaded when you enter the project directory:
direnv allowIf you prefer not to use Nix, you can build and run the project directly. This method requires manual installation of dependencies.
- CMake 3.14 or higher
- C++17 compatible compiler
- CLI11 library
- Google Test framework (for testing)
- Linux operating system
- clang-format (for code formatting)
- Just command runner (for simplified workflow)
- Node.js
sudo apt update
sudo apt install cmake build-essential libcli11-dev libgtest-dev clang-format nodejs
# Install Just command runner
curl --proto '=https' --tlsv1.2 -sSf https://just.systems/install.sh | sudo bash -s -- --to /usr/local/binsudo dnf install cmake gcc-c++ cli11-devel gtest-devel clang-tools-extra nodejs
# Install Just command runner
curl --proto '=https' --tlsv1.2 -sSf https://just.systems/install.sh | sudo bash -s -- --to /usr/local/binsudo pacman -S cmake base-devel cli11 gtest clang just nodejsThe project includes a justfile with common commands for development:
# List all available commands
just
# Build the project
just build
# Run tests
just test
# Format code
just format
# Check code formatting
just format-check
# Generates data
just gen-data output/path/file.json 1000
# Run the CLI
just run
# Install pre-commit hooks
just hooks# Configure the project
cmake -B build
# Build the project
cmake --build buildAfter building, the binary will be located in build/bin/amadeus-cli:
./build/bin/amadeus-cli -vRun all tests
ctest --test-dir build --output-on-failureThis project uses clang-format for consistent code style. A configuration file (.clang-format) based on Google's C++ style guide with small modifications is included in the repository.
# Using Nix (recommended)
nix run .#format
# Using clang-format directly
clang-format -i -style=file $(find src include test -name "*.cpp" -o -name "*.h" -o -name "*.hpp")# Using Nix (recommended)
nix run .#format-check
# Using clang-format directly
clang-format -n -Werror -style=file $(find src include test -name "*.cpp" -o -name "*.h" -o -name "*.hpp")The project is configured with pre-commit hooks to ensure code is properly formatted before committing:
# Install pre-commit hooks (done automatically in nix shell)
pre-commit installinclude/- Header filessrc/- Source filestest/- Test filescmake/- CMake configuration files
- If flakes are not enabled, add
experimental-features = nix-command flakesto your/etc/nix/nix.conf - If you see "command not found: direnv", install it via your system package manager
- Missing dependencies: Ensure all required libraries are installed
- CMake version too old: Update CMake to 3.14 or higher
- Build errors: Make sure you have a C++17 compatible compiler