jeang3nie/shitbox
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
The Harbor Feight multi tool of embedded Linux
35 Commits 1 Branch 0 Tags 9 MiB
Rust 100%
76e7036da9
Go to file
Nathan Fisher 76e7036da9 Add link applet
2023-01-12 19:00:16 -05:00
src Add link applet 2023-01-12 19:00:16 -05:00
.gitignore Initial commit 2022-12-20 12:05:21 -05:00
Cargo.lock Add fold utility 2023-01-08 11:40:08 -05:00
Cargo.toml Add fold utility 2023-01-08 11:40:08 -05:00
CONTRIBUTING.md Updated CONTRIBUTING.md 2023-01-06 23:53:41 -05:00
LICENSE Added README.md, CONTRIBUTING.md and LICENSE. Added /sbin/nologin 2022-12-25 22:27:17 -05:00
README.md Removed a brand name before making public 2023-01-10 18:32:27 -05:00

README.md

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.

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 such as su or sudo The code aims to be portable across Unix variants, ie Linux and BSD, but not MacOS or Windows. Development occurs on Linux, so if your OS is more exotic then YMMV.

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

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/shitbox help bootstrap

Supported shells for completions

  • Bash
  • Fish
  • NuShell
  • PowerShell
  • Zsh