The Lucene.NET command line interface (CLI) is a new cross-platform toolchain with utilities for maintaining Lucene.NET and demos for learning basic Lucene.NET functionality.
- .NET 6.0 Runtime or Higher (.NET 8.0 recommended)
Perform a one-time install of the lucene-cli tool using the following dotnet CLI command:
dotnet tool install lucene-cli -g --version 4.8.0-beta00016
Note
The version of the CLI you install should match the version of Lucene.NET you use.
You may then use the lucene-cli tool to analyze and update Lucene.NET indexes and use its demos.
The CLI is configured to roll-forward
to the next available major version of .NET installed on your machine, if only a newer one than .NET 8 is found.
You can control this behavior by setting the DOTNET_ROLL_FORWARD
environment variable or --roll-forward
command-line argument to Disable
to prevent rolling forward, or LatestMajor
to always use the latest
available major version, before running the CLI tool.
The following commands are installed:
CLI command structure consists of the driver ("lucene"), the command, and possibly command arguments and options. You see this pattern in most CLI operations, such as checking a Lucene.NET index for problematic segments and fixing (removing) them:
lucene index check C:\my-index --verbose
lucene index fix C:\my-index