Browse docs

← All docs

docs / cix-index.md

cix index

Builds or updates the symbol index for the current repository.

bash
$ cix index

With the GitHub App connected you rarely need this. cix keeps the index up to date as you push, so it reflects your latest pushed commit automatically. Reach for cix index to force a refresh — after a large change, or when cix doctor reports the index is stale.

Flags

FlagWhat it does
--pushBuild the index from your local working tree and upload it as your private index. No GitHub App needed; git is only read.
--fullWith --push, rebuild from scratch instead of sending what changed
--github-tokenSupply a GitHub credential for a repo no App installation covers. Takes no value — read from your environment or a hidden prompt, used once, never stored.
--file PATHReindex specific files rather than walking the repo. Repeatable.
--rebuildRequest a full rebuild
--retireRetire your duplicate index of a repo whose owner already has one, so reads fall through to theirs. Previews and asks first.
--yesWith --retire, skip the confirmation prompt

Indexing without the GitHub App

If the App isn't installed — or the code isn't on GitHub — build and upload the index yourself:

shell
$ cix index --push

Nothing reindexes on its own in this mode; run it again when you want the index to catch up. See Index without GitHub.