#cargo #cargo-subcommand

app cargo-index

Cargo subcommand to manage a registry index

8 releases

0.2.6 Jul 12, 2022
0.2.5 Feb 18, 2022
0.2.4 Aug 22, 2021
0.2.3 Apr 6, 2021
0.1.0 Dec 24, 2018

#114 in Cargo plugins

Download history 23/week @ 2023-06-04 11/week @ 2023-06-11 13/week @ 2023-06-18 19/week @ 2023-06-25 15/week @ 2023-07-02 20/week @ 2023-07-09 11/week @ 2023-07-16 5/week @ 2023-07-23 2/week @ 2023-07-30 20/week @ 2023-08-06 24/week @ 2023-08-13 54/week @ 2023-08-20 53/week @ 2023-08-27 66/week @ 2023-09-03 40/week @ 2023-09-10 8/week @ 2023-09-17

167 downloads per month


1.5K SLoC

cargo index


An experimental Cargo subcommand to access and manipulate a registry index.

See reg-index for the corresponding library that implements this command's functionality.


cargo install cargo-index

This requires at a minimum Cargo 1.60.


The cargo index command provides several sub-commands:

Subcommand Description
add Add a package to an index.
init Create a new index.
list List entries in the index.
metadata Generate JSON metadata for a package.
unyank Un-yank a crate from an index.
validate Validate the format of an index.
yank Yank a crate from an index.

Run the sub-command with --help to get more information.


Example of creating an index and manually adding a new package:

  1. cargo index init --dl https://example.com --index index

    This creates a new git repository in the directory index with the appropriate config.json file.

  2. cargo new foo

    Create a sample project to add.

  3. cd foo

  4. cargo index add --index ../index --index-url https://example.com -- --allow-dirty

    Adds the foo package to the index.

  5. cargo index list --index ../index -p foo

    Shows the JSON metadata for every version of foo in the index.


~432K SLoC