list-segments

July 8, 2026 ยท View on GitHub

Name

index-list-segments - Lists segments in an index.

Synopsis

lucene index list-segments [\<INDEX_DIRECTORY>] [?|-h|--help]

Description

After running this command to view segments, use copy-segments to copy segments from one index directory to another or delete-segments to remove segments from an index.

Arguments

INDEX_DIRECTORY

The directory of the index. If omitted, it defaults to the current working directory.

Options

?|-h|--help

Prints out a short help for the command.

Example

List the segments in the index located at X:\lucene-index\:

lucene index list-segments X:\lucene-index