I'll analyze the code and inspect the referenced packages to ensure accurate documentation.Let me look at the parent command structure and README to understand context better.I now have enough context. This is an index sources subcommand that lists discovered sources and why each was admitted or rejected. It's currently pre-implementation (returns ErrNotImplemented). Let me generate the documentation.
title: phpbotscout index sources description: List discovered sources and the reason each was admitted to or rejected from the index. date: 2026-07-28 tags: [cli, command, index, sources] authors: [Claude (claude-opus-4-8)]
phpbotscout index sources¶
List discovered sources and understand exactly why each one was admitted to — or rejected from — the search index.
Usage¶
Description¶
The phpbotscout index sources command reports on every source that the indexing pipeline has discovered, along with the decision made for each: whether it was admitted into the index or rejected, and the reason behind that decision.
This visibility is central to how phpbotscout closes the documentation loop. Because the bot answers questions from indexed sources (with citations), knowing what made it into the index — and what was filtered out — is essential when diagnosing why a particular document was or was not used to answer a question.
Typical use cases include:
- Auditing which documents, READMEs, or other sources are backing the bot's answers.
- Debugging why a specific source is missing from search results (for example, admission filters, size limits, or format restrictions).
- Reviewing rejection reasons to spot configuration gaps or content that should be made discoverable.
Pre-implementation
This command is currently a scaffold and is not yet implemented. Running it returns a "command not yet implemented" error (ErrNotImplemented). The behaviour described here reflects the command's intended purpose. Track the project's requirements specification for delivery timelines.
Configuration precedence
Like all phpbotscout commands, this command resolves its configuration in layers, from highest to lowest precedence: command-line flags → environment variables → config file → embedded defaults. Any setting can be overridden from the environment using the PHPBOTSCOUT_ prefix (for example, PHPBOTSCOUT_LOG_LEVEL).
Flags¶
This command defines no flags of its own beyond the global flags inherited from the root phpbotscout command.
| Name | Description | Default | Required |
|---|---|---|---|
-h, --help |
Display help information for the command. | false |
No |
Global flags
Global flags provided by the root command (such as logging and configuration options) are also available here. Run phpbotscout --help to see the complete list of inherited flags.
Examples¶
List all discovered sources and their admission or rejection status:
Display help for the command: