Skip to content

index command ​

Manage the package indexes searched by search, info and add (several side by side, none by default).

bash
fobis index <add|remove|list|update|check|build> [options]

How to use it, with examples: Packages and indexes.

All options ​

fobis index add ​

Add an index at the end of the user configuration's [indexes] (lowest priority).

Arguments: NAME URL

OptionValueDefaultDescription
--configTEXTUser configuration file (default ~/.config/fobis/config.ini).
--check, --no-checkRead and validate the index first.

fobis index build ​

Write an index from seeds, filling description, license and provides from each source.

Arguments: SEEDS

OptionValueDefaultDescription
--output, -oTEXTindex.tomlWhere to write the index.
--nameTEXTName of the index (default: the seeds' name).
--from-ecosystemSeed from the projects of the user's ecosystem registry.
--configTEXTUser configuration file (default ~/.config/fobis/config.ini).
--forceOverwrite an existing output file.

fobis index check ​

Validate an index: schema, names, and (with --online) that each source answers.

Arguments: PATH

OptionValueDefaultDescription
--onlineAlso check that every source is a readable source.
--jsonMachine-readable output.

fobis index list ​

List the configured indexes in priority order, with their cache state.

OptionValueDefaultDescription
--configTEXTUser configuration file (default ~/.config/fobis/config.ini).
--fobos, -fTEXTfobosProject fobos whose [indexes] are searched first.
--jsonMachine-readable output.

fobis index remove ​

Remove an index from the user configuration (and its cache).

Arguments: NAME

OptionValueDefaultDescription
--configTEXTUser configuration file (default ~/.config/fobis/config.ini).

fobis index update ​

Fetch the indexes again (and the indexes they follow).

Arguments: NAME

OptionValueDefaultDescription
--configTEXTUser configuration file (default ~/.config/fobis/config.ini).
--fobos, -fTEXTfobosProject fobos whose [indexes] are searched first.
--depthINTEGER2How far 'follows' is walked (0: configured indexes only).