cargo-local-registry - GitLite

KO | EN

gitlite — search

#hacktoberfest #typescript #golang #go #macos #nodejs #java #awesome #cli #kubernetes #vue #security #ios #open-source

cargo-local-registry

(★ 161)

A cargo subcommand to manage local registries

File Explorer

Download Latest Version (.zip)

- - ci.yml
  - release.yml
- dependabot.yml
- main.rs
- all.rs
.gitignore
Cargo.lock
Cargo.toml
LICENSE-APACHE
LICENSE-MIT
README.md

# Installation Guide

1. Get the code

git clone https://github.com/dhovart/cargo-local-registry

Downloads the entire project code from GitHub to your computer.

cd cargo-local-registry

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Rust (rustup) Rust is required to use cargo.

cargo install cargo-local-registry

Builds and installs the package published on crates.io — no need to clone the repo yourself.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Rust

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Rust (rustup) Installing via rustup also installs cargo.

cargo install cargo-local-registry

Builds and installs the package published on crates.io — no need to clone the repo yourself.

cargo build

Compiles the Rust project.

cargo local-registry sync path/to/Cargo.lock path/to/registry

Type this command into your terminal and run it.

cargo-local-registry [OPTIONS] [PATH] [COMMAND]

Type this command into your terminal and run it.

sync Sync the registry with a Cargo.lock file

Type this command into your terminal and run it.

✅ If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![CI Tests](https://github.com/dhovart/cargo-local-registry/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/dhovart/cargo-local-registry/actions/workflows/ci.yml)

# `cargo local-registry`

This is a Cargo subcommand to ease maintenance of local registries.

This support is often useful for "offline builds" by preparing the list of all
Rust dependencies ahead of time and shipping them to a build machine in a
pre-ordained format. A local registry is an index and a collection of tarballs,
all of which currently originate from crates.io.

The purpose of this subcommand will be to manage these registries and allow
adding/deleting packages with ease.

## Installation

To install from source you can execute:

```
cargo install cargo-local-registry
```

Note that you'll need the build tools listed below for this to succeed. If you'd
prefer to download precompiled binaries assembled on the CI for this repository,
you may also use the [GitHub releases][releases]

[releases]: https://github.com/dhovart/cargo-local-registry/releases

## Building

As part of the build process you will need [gcc], [openssl] and [cmake] in your
`PATH`.

[gcc]: https://gcc.gnu.org/install/download.html
[openssl]: https://www.openssl.org/source/
[cmake]: https://cmake.org/download/

Afterwards you can build this repository via:

```
cargo build
```

And the resulting binary will be inside `target/debug`

## Usage

One of the primary operations will be to create a local registry from a lock
file itself. This can be done via

```
cargo local-registry sync path/to/Cargo.lock path/to/registry
```

This command will:

* Download all dependencies from the crates.io registry
* Verify all checksums of what's downloaded
* Place all downloads in `path/to/registry`
* Prepare the index of `path/to/registry` to reflect all this information

Full usage informaton:

```
cargo-local-registry [OPTIONS] [PATH] [COMMAND]

Commands:
  sync  Sync the registry with a Cargo.lock file
  add   Add a crate to the registry
  help  Print this message or the help of the given subcommand(s)

Arguments:
  [PATH]  Path to the local registry

Options:
  -s, --sync <SYNC>    Sync the registry with lockfile (backwards compatibility)
      --host <HOST>    Registry index to sync with
      --git            Vendor git dependencies as well
      --no-delete      Don't delete older crates in the local registry directory
  -v, --verbose...     Use verbose output
  -q, --quiet          No output printed to stdout
  -c, --color <COLOR>  Coloring: auto, always, never
  -h, --help           Print help
  -V, --version        Print version
```

# License

This project is licensed under either of

* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
   http://www.apache.org/licenses/LICENSE-2.0)
 * MIT license ([LICENSE-MIT](LICENSE-MIT) or
   http://opensource.org/licenses/MIT)

at your option.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in cargo-local-registry by you, as defined in the Apache-2.0
license, shall be dual licensed as above, without any additional terms or
conditions.