A command-line tool for crate registry backup/export
https://shipyard.rs
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
52 lines
1.3 KiB
52 lines
1.3 KiB
2 years ago
|
# 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
|
||
|
|
|
||
|
|
```console
|
||
|
|
$ ./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:
|
||
|
|
|
||
|
|
```toml
|
||
|
|
{{ config_sample }}
|
||
|
|
```
|
||
|
|
|
||
|
|
## Justfile
|
||
|
|
|
||
|
|
The repository includes a `justfile` with functionality for building, testing, etc.
|
||
|
|
|
||
|
|
Included commands:
|
||
|
|
|
||
|
|
```console
|
||
|
|
$ 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:
|
||
|
|
|
||
|
|
```console
|
||
|
|
$ just generate-readme
|
||
|
|
```
|
||
|
|
|