Skip to content

Repository files navigation

FlintCLI

A command-line tool for running Flint tests against Minecraft servers. Connects via Azalea and executes tests deterministically using Minecraft's /tick command.

About Flint

Flint is a Minecraft testing framework with two main components:

  • flint-core: Core library for test specifications, parsing, loading, and spatial utilities.
  • FlintCLI (this project): CLI tool that runs tests against live servers via Azalea.

Requirements

  • Rust nightly (rustup override set nightly)
  • Minecraft server 1.21.5+
  • Bot needs operator permissions on the server

Installation

cargo build --release

Quick start

Run all tests in a directory:

flintmc example_tests/ -s localhost:25565 -r

Run a single test:

flintmc example_tests/basic_placement.json -s localhost:25565

Filter by tags:

flintmc -s localhost:25565 -t redstone

Enter interactive mode (in-game chat commands, test recording):

flintmc -s localhost:25565 -i

See USAGE.md for the full reference: all flags, output modes, interactive commands, test recording guide, and test format specification.

Debugging and Visualization

Flint Visualizer Links

When a test fails in the default Pretty format, FlintCLI automatically emits a clickable link containing the compressed test spec and failure data. Clicking this link opens it in the FlintVisualizer tool for interactive 3D inspection.

By default, the visualizer URL uses the hosted FlintViz application. You can customize this by setting the FLINT_VIZ_URL environment variable:

FLINT_VIZ_URL="http://your-viz-host:5173" flintmc example_tests/ -s localhost:25565

License

MIT

About

No description, website, or topics provided.

Resources

Stars

6 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages