cargo README

The project's README from github.com/rust-lang/cargo. As one markdown file: README.md.

Cargo

Cargo downloads your Rust project’s dependencies and compiles your project.

To start using Cargo, learn more at The Cargo Book.

To start developing Cargo itself, read the Cargo Contributor Guide.

The Cargo binary distributed through with Rust is maintained by the Cargo team for use by the wider ecosystem. For all other uses of this crate (as a binary or library) this is maintained by the Cargo team, primarily for use by Cargo and not intended for external use (except as a transitive dependency). This crate may make major changes to its APIs.

Code Status

Code documentation: https://doc.rust-lang.org/nightly/nightly-rustc/cargo/

Compiling from Source

Requirements

Cargo requires the following tools and packages to build:

cargo and rustc
A C compiler for your platform
git (to clone this repository)

Other requirements:

The following are optional based on your platform and needs.

pkg-config — This is used to help locate system packages, such as libssl headers/libraries. This may not be required in all cases, such as using vendored OpenSSL, or on Windows.
OpenSSL — Only needed on Unix-like systems and only if the vendored-openssl Cargo feature is not used.

This requires the development headers, which can be obtained from the libssl-dev package on Ubuntu or openssl-devel with apk or yum or the openssl package from Homebrew on macOS.

If using the vendored-openssl Cargo feature, then a static copy of OpenSSL will be built from source instead of using the system OpenSSL. This may require additional tools such as perl and make.

On macOS, common installation directories from Homebrew, MacPorts, or pkgsrc will be checked. Otherwise it will fall back to pkg-config.

On Windows, the system-provided Schannel will be used instead.

LibreSSL is also supported.

Optional system libraries:

The build will automatically use vendored versions of the following libraries. However, if they are provided by the system and can be found with pkg-config, then the system libraries will be used instead:

libcurl — Used for network transfers.
libgit2 — Used for fetching git dependencies.
libssh2 — Used for SSH access to git repositories.
libz (AKA zlib) — Used by the above C libraries for data compression. (Rust code uses zlib-rs instead.)

It is recommended to use the vendored versions as they are the versions that are tested to work with Cargo.

Compiling

First, you'll want to check out this repository

git clone https://github.com/rust-lang/cargo.git
cd cargo

With cargo already installed, you can simply run:

cargo build --release

Adding new subcommands to Cargo

Cargo is designed to be extensible with new subcommands without having to modify Cargo itself. See the Wiki page for more details and a list of known community-developed subcommands.

Releases

Cargo releases coincide with Rust releases. High level release notes are available as part of Rust's release notes. Detailed release notes are available in the changelog.

Reporting issues

Found a bug? We'd love to know about it!

Please report all issues on the GitHub issue tracker.

Contributing

See the Cargo Contributor Guide for a complete introduction to contributing to Cargo.

License

Cargo is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0).

See LICENSE-APACHE and LICENSE-MIT for details.

Third party software

This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (https://www.openssl.org/).

In binary form, this product includes software that is licensed under the terms of the GNU General Public License, version 2, with a linking exception, which can be obtained from the upstream repository.

See LICENSE-THIRD-PARTY for details.

Searching Database…

15.6K ·GitHub

What is this?

Cargo is the official package manager and build tool for the Rust programming language. It downloads a project's dependencies and compiles the project.

Is this a library or a CLI tool?

It is a command-line tool (the cargo binary) that ships with the Rust toolchain, though parts of it are also exposed as crates for internal use.

What do I need installed to compile Cargo myself?

You need an existing cargo and rustc, a C compiler, and git; optionally pkg-config and OpenSSL/LibreSSL headers depending on platform, since Cargo vendors libcurl, libgit2, libssh2 and libz by default.

Can I extend Cargo with my own subcommands without patching it?

Yes, Cargo is designed to support third-party subcommands without modifying Cargo itself, and the wiki lists known community subcommands.

Does Cargo run on Windows, macOS, and Linux alike?

Yes, Cargo supports all three; on Windows it uses the system-provided Schannel instead of OpenSSL, and on macOS it checks Homebrew, MacPorts, or pkgsrc installation directories.

Why would I need to compile Cargo from source instead of just installing Rust?

Most users never need to; this build process is mainly for people contributing to Cargo itself or working on the compiler toolchain.

Does Cargo need network libraries like curl or git support built in?

Yes, it relies on libcurl for network transfers and libgit2/libssh2 for fetching and authenticating git dependencies, with vendored copies used by default for compatibility.

How are Cargo releases timed?

Cargo releases are synchronized with Rust's own release schedule, with high-level notes in Rust's release notes and detailed notes in Cargo's changelog.

What are similar projects?

rye, nub, swift-package-manager, xmake, CocoaPods, yazi, zerobrew, git-cliff

Which topics is it in?

build-tool, package-manager, github, git, command-line, rust, command-line-tool, terminal, apache-2.0, cli, cross-platform, developer-tools

Creator: rust-lang
Size: 73.4 MB
Stars: 15.6K
Updated: CommitOct 16
Age: 12y
Commits · 90 Days