The Harbor Feight multi tool of embedded Linux
Go to file
2023-02-13 10:30:46 -05:00
bitflags-mini Refactoring: 2023-02-05 23:50:59 -05:00
corebox Fix bootstrap for all three binaries 2023-02-13 10:30:46 -05:00
errno Add errno workspace crate, fix error handling in unistd workspace 2023-02-13 00:26:13 -05:00
hashbox Fix bootstrap for all three binaries 2023-02-13 10:30:46 -05:00
mount Use errno workspace crate for mount and stat workspace crates 2023-02-13 00:41:58 -05:00
pkg Fix bootstrap for all three binaries 2023-02-13 10:30:46 -05:00
pw Add errno workspace crate, fix error handling in unistd workspace 2023-02-13 00:26:13 -05:00
src Fix bootstrap for all three binaries 2023-02-13 10:30:46 -05:00
unistd Add errno workspace crate, fix error handling in unistd workspace 2023-02-13 00:26:13 -05:00
unix-mode Add unix-mode (previously a submodule) 2023-02-10 21:59:07 -05:00
utilbox Fix bootstrap for all three binaries 2023-02-13 10:30:46 -05:00
.gitignore Initial commit 2022-12-20 12:05:21 -05:00
Cargo.lock Use errno workspace crate for mount and stat workspace crates 2023-02-13 00:41:58 -05:00
Cargo.toml Add errno workspace crate, fix error handling in unistd workspace 2023-02-13 00:26:13 -05:00
CONTRIBUTING.md Relicensed as GPL3, improved documentation and CONTRIBUTING 2023-01-16 19:03:25 -05:00
LICENSE Relicensed as GPL3, improved documentation and CONTRIBUTING 2023-01-16 19:03:25 -05:00
README.md Add swapoff applet 2023-02-08 16:20:25 -05:00

Contents

Introduction

Shitbox is inspired by the project busybox but with a much more limited scope. While Busybox aims to be "The swiss army knife of embedded linux" you can think of shitbox as being more like "The box store multi tool of embedded linux".

All joking aside the utilities which are present function mostly as expected and the code aims to be robust. It's written in Rust, not C, for whatever that's worth. Like Busybox it is a multi-call binary which is therefore able to share code between applets, making for an overall smaller binary.

Provided Commands

  • b2sum
  • base32
  • base64
  • basename
  • chgrp
  • chmod
  • chown
  • chroot
  • clear
  • cut
  • dirname
  • echo
  • false
  • factor
  • fold
  • groups
  • head
  • hostid
  • hostname
  • link
  • ln
  • logname
  • md5sum
  • mkfifo
  • mknod
  • mktemp
  • mountpoint
  • nologin
  • nproc
  • printenv
  • pwd
  • readlink
  • realpath
  • rev
  • rm
  • rmdir
  • sha1sum
  • sha224sum
  • sha256sum
  • sha384sum
  • sha512sum
  • sleep
  • swaplabel
  • swapoff
  • sync
  • true
  • umount
  • unlink
  • wc
  • which
  • whoami
  • yes

Scope

Shitbox does not aim to supply an entire system of utilities, but rather a subset of the most common Unix shell utilities. Things which are out of scope for the project include:

  • Shells
  • Network servers
  • Kernel module handling utilities
  • Anything requiring suid or sgid bits such as su or sudo The code is not intended to be portable across different architectures, only Linux is supported.

Full compatability with GNU coreutils is not intended. Compliance with POSIX is the main goal, with extensions provided by GNU or BSD where they make sense, and certain tweaks to improve consistency of behavior where they do not interfere with POSIX compliance.

Installation

Building is done using the official Rust toolchain. It is recommended that you install your toolchain using Rustup rather than distro packages, as old compiler versions are not supported.

cargo build --release

This produces three binaries: corebox, hashbox and utilbox. Most of the commands ordinarily provided by GNU coreutils are applets of corebox, with the exception of cryptographic hash related commands which are split out into hashbox. Linux swpecific commands ordinarily provided by the util-linux package are in utilbox.

The bootstrap applet provides facility for installing the binary, creating all required symlinks and installing some nice to haves such as Unix man pages and shell completions [see below].

target/release/corebox help bootstrap

Supported shells for completions

  • Bash
  • Fish
  • NuShell
  • PowerShell
  • Zsh