Skip to content

phpbotscout index status

Reports what is in the index, per source, and how stale each one is.

Unlike build, refresh and sources, status reads the local index only. It needs no forge access and works while discovery is unavailable.

Usage

$ phpbotscout index status
SOURCE                    DOCS  CHUNKS  COMMIT    AGE
phpboyscout/go/config     57    640     abc123de  3h
phpboyscout/go/forge      41    502     4f2a91bc  3h
phpboyscout/go/controls   0     0                 never

phpboyscout/go/controls last failed: clone refused

An empty index says what to do about it rather than printing a bare header:

$ phpbotscout index status
Nothing indexed yet. Run `phpbotscout index build`.

Reading the output

Column Meaning
SOURCE The canonical namespace path the forge reported. This is the identity a source is keyed by — forges redirect renamed and transferred projects, and directory names do not reliably match project names.
DOCS Documents indexed from that source.
CHUNKS Retrievable passages those documents were split into.
COMMIT First 8 characters of the indexed commit. Enough to recognise; the full SHA is noise.
AGE How long since that source last indexed successfully, or never.

Age is relative rather than an absolute timestamp because the question being asked is "is this current enough to answer from", and a timestamp makes the reader do the subtraction.

Failures

A source that failed its last run shows the reason beneath the table, so status answers why something is stale and not merely that it is. The reason is recorded when the failure happens, so it survives the run that produced it — you do not need to have been watching the terminal.

Staleness is not an outage

A stale index does not fail the daemon's readiness. Answering from what is already indexed, with a caveat, beats not answering, and taking the bot out of service would not fix a forge nobody can reach. status is where staleness surfaces so an operator can act on it — see serve.

Flags

status defines no flags of its own. Global flags (--config, --debug, --output, --ci) are inherited from the root command.

Name Description Default
-h, --help Help for status. false

See also