A command-line tool for crate registry backup/export https://shipyard.rs

History

Jonathan Strong ea7545dc61 fix typo in readme		2 years ago
..
README.tera.md	fix typo in readme	2 years ago
cli-menu.txt	adds template-based README.md with script to re-generate	2 years ago
just-commands.txt	adds template-based README.md with script to re-generate	2 years ago

README.tera.md

registry-backup

A command line utility for downloading all .crate files hosted by a Cargo registry server.

Use cases:

Backup: retrieve a registry server's files for backup storage
Export: pull the files so you can host them at another registry server

Runtime Options

$ ./target/release/registry-backup --help

{{ cli_menu }}

Configuration File

A toml configuration file may be used instead of command line flags. A sample file (config.toml.sample) is included. From the example file:

{{ config_sample }}

Justfile

The repository includes a justfile with functionality for building, testing, etc.

Included commands:

$ just --list

{{ just_commands }}

The commands that mirror cargo commands (e.g. just test) are included for the purpose of convenience, so that various options (e.g. RUSTFLAGS='-C target-cpu=native) can be included without typing them out each time.

Generating README.md

This file is generated using a template (doc/README.tera.md) rendered using updated outputs of the CLI menu, config sample, and other values.

This version of README.md was generated at {{ generation_time }} based on git commit {{ git_commit }}.

To (re-)generate the README.md file, use the justfile command:

$ just generate-readme