Skip to content

Let me inspect the referenced packages to ensure accurate documentation.--- title: phpbotscout index status description: Reports what is currently indexed and how stale the index has become. date: 2026-07-28 tags: [cli, command, index, status] authors: [Claude (claude-opus-4-8)]

phpbotscout index status

The phpbotscout index status command reports on the state of the tool's index, summarising what has been indexed and indicating how stale that data may be.

Not Yet Implemented

This command is currently a placeholder. Invoking it will return an ErrNotImplemented error until the underlying functionality is completed. See the Description section for details.

Usage

phpbotscout index status [flags]

Description

The index status command is designed to give you a quick, at-a-glance report of the current index. When fully implemented, it will surface information such as:

  • What data has been indexed.

  • How stale the indexed data is (i.e. how long since the last refresh).

This helps you decide whether you need to re-run an indexing operation before relying on results derived from the index.

Current Behaviour

The command is wired up through the GTB command framework, but the core logic (RunStatus) currently returns the sentinel error ErrNotImplemented from the errorhandling package. This means the command is registered and discoverable, but running it will report that the feature is not yet available.

Under the hood, the command participates in the standard GTB lifecycle:

  • During PreRunE, it registers the command's usage output with the shared error handler so that any usage-related errors can be rendered with the correct help text.

  • During RunE, it delegates execution to RunStatus, passing along the command context, the shared Props dependency container, the command options, and any positional arguments.

Flags

This command defines no local flags of its own.

Name Description Default Required
-h, --help Displays help information for the index status command. false No

Global Flags

Additional global (persistent) flags may be inherited from the root phpbotscout command. Run phpbotscout index status --help to view the complete, up-to-date list available in your installed version.

Examples

Report the current index status:

$ phpbotscout index status

Display help for the command:

$ phpbotscout index status --help