Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/GrayJack/coreutils
Core utils re-implementation for UNIX/UNIX-like systems written in Rust
https://github.com/GrayJack/coreutils
coreutils hacktoberfest rust rust-lang unix
Last synced: about 1 month ago
JSON representation
Core utils re-implementation for UNIX/UNIX-like systems written in Rust
- Host: GitHub
- URL: https://github.com/GrayJack/coreutils
- Owner: GrayJack
- License: mpl-2.0
- Created: 2019-04-12T05:57:31.000Z (over 5 years ago)
- Default Branch: dev
- Last Pushed: 2023-07-12T01:13:26.000Z (about 1 year ago)
- Last Synced: 2024-05-01T14:38:06.720Z (5 months ago)
- Topics: coreutils, hacktoberfest, rust, rust-lang, unix
- Language: Rust
- Homepage:
- Size: 2.6 MB
- Stars: 103
- Watchers: 4
- Forks: 38
- Open Issues: 44
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Coreutils in Rust
[](https://hitsofcode.com/view/github/GrayJack/coreutils)
[](https://travis-ci.com/GrayJack/coreutils)
[](https://app.fossa.io/projects/git%2Bgithub.com%2FGrayJack%2Fcoreutils?ref=badge_shield)
An in-progress safe implementation of `coreutils` aiming for a minimal and yet
complete set of utilities. This project aims at the _POSIX_ specification basic
requirements, plus common and useful features present in other implementations
of the utility.
This project has no intent to be 100% compatible with _GNU's coreutils_, like
[Uutils' coreutils](https://github.com/uutils/coreutils), but if it happens to
be, it's okay too.
## Minimum Rust Version Policy
This project's minimum supported `rustc` version (_MSRV_) is _1.58.0_.
This will not be conservative until we get to a _1.0_ version. So it can be
changed at any point in time.
## Compilation tests guarantees
The compilation is tested for Rust Tier 1 and Tier 2 _x86_64 Unix/Unix-like_
platforms (except _Redox_), with _CI_.
All platforms are tested on _MSRV_ and _stable_ _Rust_, and Tier 1 platforms are
also tested on _beta_ and _nightly_ _Rust_ (Tier 2 and 3 only guarantee _stable_
full capacity).
Also, note that Tier 3 Rust tests can fail before it hits the compilation check,
since my only option is to use a _Linux_ system, add the target, and do
`cargo check --target`, and they often are not available as a target for any
Tier 1 platforms. If you use one of these platforms and have the right MSRV
requirements and it build successfully, let me know, if it fails, open an issue
with the compilation error.
| Platform | Tier | CI Status | Manual Status |
| :----------: | :----: | :--------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------: |
| Linux | Tier 1 | [](https://github.com/GrayJack/coreutils/actions) | Passing (Manjaro Linux 5.3.2 - 2019-10-28) (8695863) |
| MacOS | Tier 1 | [](https://github.com/GrayJack/coreutils/actions) | - |
| FreeBSD | Tier 2 | [](https://github.com/GrayJack/coreutils/actions) | Passing (FreeBSD 12.0 - 2019-10-28) (8695863) |
| NetBSD | Tier 2 | [](https://github.com/GrayJack/coreutils/actions) | - (system without minimal version) |
| Illumos | Tier 2 | [](https://github.com/GrayJack/coreutils/actions) | - (system without minimal version) |
| Solaris | Tier 2 | [](https://github.com/GrayJack/coreutils/actions) | - (system without minimal version) |
| Fuchsia | Tier 2 | [](https://github.com/GrayJack/coreutils/actions) | - |
| OpenBSD | Tier 3 | [](https://github.com/GrayJack/coreutils/actions) | Passing (OpenBSD 6.6 Current - 2019-10-28) (8695863) |
| DragonflyBSD | Tier 3 | [](https://github.com/GrayJack/coreutils/actions) | Passing (DragonflyBSD 5.6.2 - 2019-10-28) (8695863) |
| Haiku | Tier 3 | [](https://github.com/GrayJack/coreutils/actions) | - |
## Compilation
Since not all targets provide full _Unix_ API coverage (they aren't _Unix_ or
lack _libc_ crate support), some can provide a `Cargo.toml` that have all
utilities that should work on the target.
### Compilation example for
```sh
cp .toml Cargo.toml
cargo build --release
```
## Tools
| Name | Not Started | Started | Done |
| :------: | :---------: | :-----: | :--: |
| basename | | | X |
| cat | | X | |
| chgrp | X | | |
| chmod | X | | |
| chown | X | | |
| chroot | | | X |
| clear | | | X |
| comm | X | | |
| cp | X | | |
| csplit | | X | |
| cut | | | X |
| date | | X | |
| dd | X | | |
| df | X | | |
| diff | X | | |
| dirname | | | X |
| du | | | X |
| echo | | | X |
| env | | | X |
| expand | | | X |
| expr | X | | |
| false | | | X |
| groups | | | X |
| hash | X | | |
| head | | | X |
| id | | | X |
| install | X | | |
| join | X | | |
| link | | | X |
| ln | X | | |
| logname | | | X |
| ls | | | X |
| mkdir | | | X |
| mktemp | | | X |
| mkfifo | X | | |
| mv | | | X |
| nice | | | X |
| nl | | | X |
| nohup | | | X |
| od | X | | |
| paste | X | | |
| patch | X | | |
| printf | | | X |
| pwd | | | X |
| rm | | | x |
| rmdir | | | X |
| sed | X | | |
| seq | | X | |
| sort | | X | |
| sleep | | | X |
| split | X | | |
| stat | X | | |
| stty | X | | |
| tail | | X | |
| tee | | X | |
| test | X | | |
| time | X | | |
| touch | | X | |
| tr | X | | |
| true | | | X |
| tsort | X | | |
| tty | | | X |
| uname | | | X |
| unexpand | | | X |
| uniq | | X | |
| unlink | | | X |
| uptime | | | X |
| users | | | X |
| wc | | | X |
| who | | | X |
| whoami | | | X |
| yes | | | X |
## Licensing
This software is licensed under the [Mozilla Public License, v. 2.0](./LICENSE)
(MPL). If a copy of the MPL was not distributed with this file, you can obtain
one at http://mozilla.org/MPL/2.0/.
## Contributing
We appreciate contributions, please check [CONTRIBUTING.md](./CONTRIBUTING.md)
for guidelines on how to contribute to the project with issue reports, git
commits messages, etc.
The document also gives orientation on where to start if you wanna implement a
pending tool from scratch.
## Contributors
Without them, this project would not be what it is today.
- Ashwin-A-K
- [@bojan88](https://github.com/bojan88) - _Bojan Đurđević_
- [@Celeo](https://github.com/Celeo) - _Celeo_
- [@FedericoPonzi](https://github.com/FedericoPonzi) - _Federico Ponzi_
- [@Larisho](https://github.com/Larisho) - _Gab David_
- [@silverweed](https://github.com/silverweed) - _Giacomo Parolini_
- [@marcospb19](https://github.com/marcospb19) - _João M. Bezerra_
- [@kegesch](https://github.com/kegesch) - _Jonas Geschke_
- Ladysamantha
- [@mkindahl](https://github.com/mkindahl) - _Mats Kindah_
- [@MichelKansou](https://github.com/MichelKansou) - _Michel Kansou_
- [@twe4ked](https://github.com/twe4ked) - _Odin Dutton_
- [@rodrigocam](https://github.com/rodrigocam) - _Rodrigo Oliveira Campos_
- [@Albibek](https://github.com/Albibek) - _Sergey Noskov_
- [@palfrey](https://github.com/palfrey) - _Tom Parker-Shemilt_
- [@tobbez](https://github.com/tobbez) - _Torbjörn Lönnemark_
- [@envp](https://github.com/envp) - _Vaibhav Yenamandra_
- [@muskuloes](https://github.com/muskuloes) - _Victor Tuekam_