Repository files navigation

uutils coreutils is a cross-platform reimplementation of the GNU coreutils inRust. While all programs have been implemented, someoptions might be missing or different behavior might be experienced.

To install it:

cargo install coreutils~/.cargo/bin/coreutils

uutils aims to be a drop-in replacement for the GNU utils. Differences with GNUare treated as bugs.

uutils aims to work on as many platforms as possible, to be able to use the sameutils on Linux, Mac, Windows and other platforms. This ensures, for example,that scripts can be easily transferred between platforms.

uutils has both user and developer documentation available:

• User Manual
• Developer Documentation

Both can also be generated locally, the instructions for that can be found inthecoreutils docs repository.

• Rust (cargo,rustc)
• GNU Make (optional)

uutils follows Rust's release channels and is tested against stable, beta andnightly. The current Minimum Supported Rust Version (MSRV) is1.64.0.

There are currently two methods to build the uutils binaries: either Cargo orGNU Make.

Building the full package, including all documentation, requires both Cargoand Gnu Make on a Unix platform.

For either method, we first need to fetch the repository:

git clone https://github.com/uutils/coreutilscd coreutils

Building uutils using Cargo is easy because the process is the same as for everyother Rust program:

cargo build --release

This command builds the most portable common core set of uutils into a multicall(BusyBox-type) binary, named 'coreutils', on most Rust-supported platforms.

Additional platform-specific uutils are often available. Building these expandedsets of uutils for a platform (on that platform) is as simple as specifying itas a feature:

cargo build --release --features macos# or ...cargo build --release --features windows# or ...cargo build --release --features unix

If you don't want to build every utility available on your platform into thefinal binary, you can also specify which ones you want to build manually. Forexample:

cargo build --features"base32 cat echo rm" --no-default-features

If you don't want to build the multicall binary and would prefer to build theutilities as individual binaries, that is also possible. Each utility iscontained in its own package within the main repository, named "uu_UTILNAME". Tobuild individual utilities, use cargo to build just the specific packages (usingthe--package [aka-p] option). For example:

cargo build -p uu_base32 -p uu_cat -p uu_echo -p uu_rm

Building usingmake is a simple process as well.

To simply build all available utilities:

make

In release mode:

make PROFILE=release

To build all but a few of the available utilities:

make SKIP_UTILS='UTILITY_1 UTILITY_2'

To build only a few of the available utilities:

make UTILS='UTILITY_1 UTILITY_2'

Likewise, installing can simply be done using:

cargo install --path. --locked

This command will install uutils into Cargo'sbin folder (e.g.$HOME/.cargo/bin).

This does not install files necessary for shell completion or manpages. Formanpages or shell completion to work, useGNU Make or seeManually install shell completions/Manually install manpages.

To install all available utilities:

make install

To install usingsudo switch-E must be used:

sudo -E make install

To install all but a few of the available utilities:

make SKIP_UTILS='UTILITY_1 UTILITY_2' install

To install only a few of the available utilities:

make UTILS='UTILITY_1 UTILITY_2' install

To install every program with a prefix (e.g. uu-echo uu-cat):

make PROG_PREFIX=PREFIX_GOES_HERE install

To install the multicall binary:

make MULTICALL=y install

Set install parent directory (default value is /usr/local):

# DESTDIR is also supportedmake PREFIX=/my/path install

Installing withmake installs shell completions for all installed utilitiesforbash,fish andzsh. Completions forelvish andpowershell can alsobe generated; SeeManually install shell completions.

Thecoreutils binary can generate completions for thebash,elvish,fish,powershell andzsh shells. It prints the result to stdout.

The syntax is:

cargo run completion<utility><shell>

So, to install completions forls onbash to/usr/local/share/bash-completion/completions/ls, run:

cargo run completion ls bash> /usr/local/share/bash-completion/completions/ls

To generate manpages, the syntax is:

cargo run manpage<utility>

So, to install the manpage forls to/usr/local/share/man/man1/ls.1 run:

cargo run manpage ls> /usr/local/share/man/man1/ls.1

Un-installation differs depending on how you have installed uutils. If you usedCargo to install, use Cargo to uninstall. If you used GNU Make to install, useMake to uninstall.

To uninstall uutils:

cargo uninstall uutils

To uninstall all utilities:

make uninstall

To uninstall every program with a set prefix:

make PROG_PREFIX=PREFIX_GOES_HERE uninstall

To uninstall the multicall binary:

make MULTICALL=y uninstall

To uninstall from a custom parent directory:

# DESTDIR is also supportedmake PREFIX=/my/path uninstall

Below is the evolution of how many GNU tests uutils passes. A more detailedbreakdown of the GNU test results of the main branch can be foundin the user manual.

See#3336 for the main meta bugs(many are missing).

To contribute to uutils, please seeCONTRIBUTING.

uutils is licensed under the MIT License - see theLICENSE file for details

GNU Coreutils is licensed under the GPL 3.0 or later.