uutils is an attempt at writing universal (as in cross-platform) CLI utilities in Rust. This repository is intended to aggregate GNU coreutils rewrites.
Many GNU, Linux and other utilities are useful, and obviously some effort has been spent in the past to port them to Windows. However, those projects are either old and abandoned, are hosted on CVS (which makes it more difficult for new contributors to contribute to them), are written in platform-specific C, or suffer from other issues.
Rust provides a good, platform-agnostic way of writing systems utilities that are easy to compile anywhere, and this is as good a way as any to try and learn it.
- Rust (
cargo,rustc) - GNU Make (required to build documentation)
- Sphinx (for documentation)
- gzip (for installing documentation)
uutils follows Rust's release channels and is tested against stable, beta and nightly.
The current oldest supported version of the Rust compiler is 1.32.0.
On both Windows and Redox, only the nightly version is tested currently.
There are currently two methods to build uutils: GNU Make and Cargo. However, while there may be two methods, both systems are required to build on Unix (only Cargo is required on Windows).
First, for both methods, we need to fetch the repository:
$ git clone https://github.com/uutils/coreutils
$ cd coreutilsBuilding uutils using Cargo is easy because the process is the same as for every other Rust program:
# to keep debug information, compile without --release
$ cargo build --releaseBecause the above command attempts to build utilities that only work on Unix-like platforms at the moment, to build on Windows, you must do the following:
# to keep debug information, compile without --release
$ cargo build --release --no-default-features --features windowsIf you don't want to build every utility available on your platform into the multicall binary (the Busybox-esque binary), you can also specify which ones you want to build manually. For example:
$ cargo build --features "base32 cat echo rm" --no-default-featuresIf you don't even want to build the multicall binary and would prefer to just build the utilities as individual binaries, that is possible too. For example:
$ cargo build -p uu_base32 -p uu_cat -p uu_echo -p uu_rmBuilding using make is a simple process as well.
To simply build all available utilities:
$ makeTo 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 installThis command will install uutils into Cargo's bin folder (e.g. $HOME/.cargo/bin).
To install all available utilities:
$ make installTo install using sudo switch -E must be used:
$ sudo -E make installTo install all but a few of the available utilities:
$ make SKIP_UTILS='UTILITY_1 UTILITY_2' installTo install only a few of the available utilities:
$ make UTILS='UTILITY_1 UTILITY_2' installTo install every program with a prefix (e.g. uu-echo uu-cat):
$ make PROG_PREFIX=PREFIX_GOES_HERE installTo install the multicall binary:
$ make MULTICALL=y installSet install parent directory (default value is /usr/local):
# DESTDIR is also supported
$ make PREFIX=/my/path installFor wasm32-wasi target some C libs need to be build with wasi-SDK like the following:
First install wasi-SDK
export WASI_VERSION=14
export WASI_VERSION_FULL=${WASI_VERSION}.0
wget https://github.com/WebAssembly/wasi-sdk/releases/download/wasi-sdk-${WASI_VERSION}/wasi-sdk-${WASI_VERSION_FULL}-linux.tar.gz
tar xvf wasi-sdk-${WASI_VERSION_FULL}-linux.tar.gzThen use clang installed in the wasi-sdk directory to build wasm32-wasi target:
export WASI_SDK_PATH=`pwd`/wasi-sdk-${WASI_VERSION_FULL}
CC="${WASI_SDK_PATH}/bin/clang --sysroot=${WASI_SDK_PATH}/share/wasi-sysroot" cargo build --target wasm32-wasi --release --features wasiThe standard package set of NixOS provides this package out of the box since 18.03:
nix-env -iA nixos.uutils-coreutils
Uninstallation differs depending on how you have installed uutils. If you used Cargo to install, use Cargo to uninstall. If you used GNU Make to install, use Make to uninstall.
To uninstall uutils:
$ cargo uninstall uutilsTo uninstall all utilities:
$ make uninstallTo uninstall every program with a set prefix:
$ make PROG_PREFIX=PREFIX_GOES_HERE uninstallTo uninstall the multicall binary:
$ make MULTICALL=y uninstallTo uninstall from a custom parent directory:
# DESTDIR is also supported
$ make PREFIX=/my/path uninstallTesting can be done using either Cargo or make.
Just like with building, we follow the standard procedure for testing using Cargo:
$ cargo testBy default, cargo test only runs the common programs. To run also platform
specific tests, run:
$ cargo test --features unixIf you would prefer to test a select few utilities:
$ cargo test --features "chmod mv tail" --no-default-featuresTo debug:
$ gdb --args target/debug/coreutils ls
(gdb) b ls.rs:79
(gdb) runTo simply test all available utilities:
$ make testTo test all but a few of the available utilities:
$ make SKIP_UTILS='UTILITY_1 UTILITY_2' testTo test only a few of the available utilities:
$ make UTILS='UTILITY_1 UTILITY_2' testTo include tests for unimplemented behavior:
$ make UTILS='UTILITY_1 UTILITY_2' SPEC=y testThis testing functionality is only available on *nix operating systems and
requires make.
To run busybox's tests for all utilities for which busybox has tests
$ make busytestTo run busybox's tests for a few of the available utilities
$ make UTILS='UTILITY_1 UTILITY_2' busytestTo pass an argument like "-v" to the busybox test runtime
$ make UTILS='UTILITY_1 UTILITY_2' RUNTEST_ARGS='-v' busytestTo contribute to uutils, please see CONTRIBUTING.
| Done | Semi-Done | To Do |
|---|---|---|
| arch | cp | chcon |
| base32 | expr | dd |
| base64 | install | numfmt |
| basename | ls | pr |
| cat | more | runcon |
| chgrp | od (--strings and 128-bit data types missing) |
stty |
| chmod | printf | |
| chown | sort | |
| chroot | split | |
| cksum | tail | |
| comm | test | |
| csplit | date | |
| cut | join | |
| dircolors | df | |
| dirname | ||
| du | ||
| echo | ||
| env | ||
| expand | ||
| factor | ||
| false | ||
| fmt | ||
| fold | ||
| groups | ||
| hashsum | ||
| head | ||
| hostid | ||
| hostname | ||
| id | ||
| kill | ||
| link | ||
| ln | ||
| logname | ||
| mkdir | ||
| mkfifo | ||
| mknod | ||
| mktemp | ||
| mv | ||
| nice | ||
| nl | ||
| nohup | ||
| nproc | ||
| paste | ||
| pathchk | ||
| pinky | ||
| printenv | ||
| ptx | ||
| pwd | ||
| readlink | ||
| realpath | ||
| relpath | ||
| rm | ||
| rmdir | ||
| seq | ||
| shred | ||
| shuf | ||
| sleep | ||
| stat | ||
| stdbuf | ||
| sum | ||
| sync | ||
| tac | ||
| tee | ||
| timeout | ||
| touch | ||
| tr | ||
| true | ||
| truncate | ||
| tsort | ||
| tty | ||
| uname | ||
| unexpand | ||
| uniq | ||
| unlink | ||
| uptime | ||
| users | ||
| wc | ||
| who | ||
| whoami | ||
| yes |
uutils is licensed under the MIT License - see the LICENSE file for details
