I'll analyze the code and inspect the referenced packages to ensure accurate documentation.I now have enough context to generate accurate documentation.
title: phpbotscout index build description: Builds the phpbotscout search index from scratch. date: 2026-07-28 tags: [cli, command, index, build] authors: [Claude (claude-opus-4-8)]
phpbotscout index build¶
The phpbotscout index build command constructs the search index from scratch, discarding any previously built index data and regenerating it from the ground up.
Usage¶
Description¶
The build subcommand rebuilds the phpbotscout index in a single pass. Unlike incremental update operations, this command performs a full build, making it useful for the very first indexing run or when you need to guarantee a clean, consistent index state.
The command is wired into the phpbotscout CLI as a subcommand of index and integrates with the shared dependency container (Props), which supplies configuration, logging, filesystem access, and a structured error handler.
Before execution, the command registers its usage printer with the error handler. This ensures that if a failure occurs which requires displaying command usage (for example, an error wrapping a sub-command routing failure), the correct help text is presented to the user.
Not Yet Implemented
This command is currently a stub. Invoking it returns the ErrNotImplemented error (command not yet implemented) from the underlying errorhandling package. The build logic has not yet been added, so running it will not perform any indexing.
Error Handling
Errors returned by this command are routed through the tool's structured error handler. When debug logging is enabled, richer diagnostics such as stack traces and error details are emitted; under normal operation, output remains concise and user-friendly.
Flags¶
This command defines no local flags of its own. Only inherited global and persistent flags provided by the parent phpbotscout command are available.
| Name | Description | Default | Required |
|---|---|---|---|
-h, --help |
Displays help information for the build command. |
false |
No |
Global Flags
Additional persistent flags (such as logging verbosity or configuration overrides) may be inherited from the root phpbotscout command. Run phpbotscout index build --help to see the complete, up-to-date list available in your installed version.
Examples¶
Build the index from scratch:
Display help for the command: