Show / Hide Table of Contents

    Lucene.Net command line interface (CLI) tools

    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.

    Prerequisites

    • .NET Core 3.1.0 Runtime

    Installation

    Perform a one-time install of the lucene-cli tool using the following dotnet CLI command:

    dotnet tool install lucene-cli -g --version [EnvVar:LuceneNetVersion]
    

    You may then use the lucene-cli tool to analyze and update Lucene.Net indexes and use its demos.

    CLI Commands

    The following commands are installed:

    • analysis
    • demo
    • index
    • lock

    Command structure

    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
    
    • Improve this Doc
    Back to top Copyright © 2020 Licensed to the Apache Software Foundation (ASF)