uutils coreutils
uutils is an attempt at writing universal (as in cross-platform) CLI utils in Rust. This repo is to aggregate the GNU coreutils rewrites.
Why?
Many GNU, Linux and other utils are pretty awesome, and obviously some effort has been spent in the past to port them to Windows. However, those projects are either old, abandoned, hosted on CVS, written in platform-specific C, etc.
Rust provides a good, platform-agnostic way of writing systems utils that are easy to compile anywhere, and this is as good a way as any to try and learn it.
Requirements
- Rust (
cargo
,rustc
) - GNU Make (required to build documentation)
- Sphinx (for documentation)
- gzip (for installing documentation)
Rust Version
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.31.0
.
On both Windows and Redox, only the nightly version is tested currently.
Build Instructions
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:
Cargo
Building uutils using Cargo is easy because the process is the same as for every other Rust program:
# to keep debug information, compile without --release
Because 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
If 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:
If 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:
GNU Make
Building using make
is a simple process as well.
To simply build all available utilities:
To build all but a few of the available utilities:
To build only a few of the available utilities:
Installation Instructions
Cargo
Likewise, installing can simply be done using:
This command will install uutils into Cargo's bin folder (e.g. $HOME/.cargo/bin
).
GNU Make
To install all available utilities:
To install using sudo
switch -E
must be used:
To install all but a few of the available utilities:
To install only a few of the available utilities:
To install every program with a prefix (e.g. uu-echo uu-cat):
To install the multicall binary:
Set install parent directory (default value is /usr/local):
# DESTDIR is also supported
NixOS
The standard package set of NixOS provides this package out of the box since 18.03:
nix-env -iA nixos.uutils-coreutils
Uninstallation Instructions
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.
Cargo
To uninstall uutils:
GNU Make
To uninstall all utilities:
To uninstall every program with a set prefix:
To uninstall the multicall binary:
To uninstall from a custom parent directory:
# DESTDIR is also supported
Test Instructions
Testing can be done using either Cargo or make
.
Cargo
Just like with building, we follow the standard procedure for testing using Cargo:
By default, cargo test
only runs the common programs. To run also platform
specific tests, run:
If you would prefer to test a select few utilities:
GNU Make
To simply test all available utilities:
To test all but a few of the available utilities:
To test only a few of the available utilities:
To include tests for unimplemented behavior:
Run Busybox Tests
This 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
To run busybox's tests for a few of the available utilities
To pass an argument like "-v" to the busybox test runtime
Contribute
To contribute to uutils, please see CONTRIBUTING.
Utilities
Done | Semi-Done | To Do |
---|---|---|
arch | cp | chcon |
base32 | expr | csplit |
base64 | install | dd |
basename | ls | numfmt |
cat | more | pr |
chgrp | od (--strings and 128-bit data types missing) |
runcon |
chmod | printf | stty |
chown | sort | |
chroot | split | |
cksum | tail | |
comm | test | |
cut | date | |
dircolors | join | |
dirname | df | |
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 |
License
uutils is licensed under the MIT License - see the LICENSE
file for details