To install it:

cargo install coreutils~/.cargo/bin/coreutils

Goals

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.

Useweblate/rust-coreutils to translate the Rust coreutils into your language.

• 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.85.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

Replace--release with--profile=release-fast or--profile=release-small to use all optimizations or save binary size.

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

To build SELinux-specific features, includingchcon andruncon, ensure thatlibselinuxandlibclang are installed on your system. Then, run the following command:

cargo build --release --features unix,feat_selinux

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 want to build the utilities as individual binaries, that is also possible:

cargo build --release --bins --workspace --exclude coreutils --exclude uu_runcon --exclude uu_chcon

Each utility is contained in its own package within the main repository, named "uu_UTILNAME". Tobuild selected individual utilities, use the--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 (with debug profile):

make

In release-fast mode:

make PROFILE=release-fast

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 all utilities with all possible optimizations:

make PROFILE=release-fast 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=uu- install

PROG_PREFIX requires separator-,_, or=.

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.

To skip installation of completions and manpages:

make COMPLETIONS=n MANPAGES=n install

Theuudoc binary generates completions for thebash,elvish,fish,powershell andzsh shells to stdout.

Installuudoc by

cargo install --bin uudoc --features uudoc --path.

Then use the installed binary:

uudoc completion<utility><shell>

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

uudoc completion ls bash> /usr/local/share/bash-completion/completions/ls.bash

Completion for prefixedcp withuu- onzsh is generated by

env PROG_PREFIX=uu- uudoc completion cp zsh

To generate manpages, the syntax is:

uudoc manpage<utility>

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

uudoc 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 coreutils

To uninstall all utilities:

make uninstall

To uninstall every program with a set prefix:

make PROG_PREFIX=uu- 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.

Seehttps://github.com/orgs/uutils/projects/1 for the main meta bugs(many are missing).

Contributing

License