coreutils

by uutils

uutils / coreutils

Cross-platform Rust rewrite of the GNU coreutils

6.2K Stars 488 Forks Last release: 5 months ago (0.0.1.1) MIT License 3.4K Commits 2 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

uutils coreutils

Discord License FOSSA Status LOC dependency status

Build Status Build Status (Windows) Build Status (FreeBSD) codecov


uutils is an attempt at writing universal (as in cross-platform) CLI utilities in Rust. This repository is intended to aggregate GNU coreutils rewrites.

Why?

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.

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.32.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:

bash
$ git clone https://github.com/uutils/coreutils
$ cd coreutils

Cargo

Building uutils using Cargo is easy because the process is the same as for every other Rust program: ```bash

to keep debug information, compile without --release

$ cargo build --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: ```bash

to keep debug information, compile without --release

$ cargo build --release --no-default-features --features windows ```

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:

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

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:

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

GNU Make

Building using

make
is a simple process as well.

To simply build all available utilities:

bash
$ make

To build all but a few of the available utilities:

bash
$ make SKIP_UTILS='UTILITY_1 UTILITY_2'

To build only a few of the available utilities:

bash
$ make UTILS='UTILITY_1 UTILITY_2'

Installation Instructions

Cargo

Likewise, installing can simply be done using:

bash
$ cargo install

This command will install uutils into Cargo's bin folder (e.g.

$HOME/.cargo/bin
).

GNU Make

To install all available utilities:

bash
$ make install

To install using

sudo
switch
-E
must be used:
bash
$ sudo -E make install

To install all but a few of the available utilities:

bash
$ make SKIP_UTILS='UTILITY_1 UTILITY_2' install

To install only a few of the available utilities:

bash
$ make UTILS='UTILITY_1 UTILITY_2' install

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

bash
$ make PROG_PREFIX=PREFIX_GOES_HERE install

To install the multicall binary:

bash
$ make MULTICALL=y install

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

DESTDIR is also supported

$ make PREFIX=/my/path install ```

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:

bash
$ cargo uninstall uutils

GNU Make

To uninstall all utilities:

bash
$ make uninstall

To uninstall every program with a set prefix:

bash
$ make PROG_PREFIX=PREFIX_GOES_HERE uninstall

To uninstall the multicall binary:

bash
$ make MULTICALL=y uninstall

To uninstall from a custom parent directory: ```bash

DESTDIR is also supported

$ make PREFIX=/my/path uninstall ```

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:

bash
$ cargo test

By default,

cargo test
only runs the common programs. To run also platform specific tests, run:
bash
$ cargo test --features unix

If you would prefer to test a select few utilities:

bash
$ cargo test --features "chmod mv tail" --no-default-features

To debug:

bash
$ gdb --args target/debug/coreutils ls
(gdb) b ls.rs:79
(gdb) run

GNU Make

To simply test all available utilities:

bash
$ make test

To test all but a few of the available utilities:

bash
$ make SKIP_UTILS='UTILITY_1 UTILITY_2' test

To test only a few of the available utilities:

bash
$ make UTILS='UTILITY_1 UTILITY_2' test

To include tests for unimplemented behavior:

bash
$ make UTILS='UTILITY_1 UTILITY_2' SPEC=y test

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

bash
$ make busytest

To run busybox's tests for a few of the available utilities

bash
$ make UTILS='UTILITY_1 UTILITY_2' busytest

To pass an argument like "-v" to the busybox test runtime

bash
$ make UTILS='UTILITY_1 UTILITY_2' RUNTEST_ARGS='-v' busytest

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 | | | | ~~md5sum~~ (replaced by hashsum) | | | ~~sha1sum~~ (replaced by hashsum) | | | ~~sha224sum~~ (replaced by hashsum) | | | ~~sha256sum~~ (replaced by hashsum) | | | ~~sha384sum~~ (replaced by hashsum) | | | ~~sha512sum~~ (replaced by hashsum) | | | 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

FOSSA Status

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.