Skip to content

Latest commit

 

History

History
161 lines (132 loc) · 8.55 KB

README.md

File metadata and controls

161 lines (132 loc) · 8.55 KB
Raw

Build UnitTest IntegrationTest GitHub GitHub all releases Lines of code Support me on Patreon

[日本語]

MimixBox - mimic BusyBox on Linux

MimixBox has many Unix commands in the single binary like BusyBox. However, MimixBox aim for the different uses from BusyBox. Specifically, it is supposed to be used in the desktop environment, not the embedded environment.
Also, the MimixBox project maintainer plan to have a wide range of built-in commands (applets) from basic command provided by Coreutils and others to experimental commands.

Installation.

The source code and binaries are distributed on the Release Page in ZIP format and tar.gz format. Choose the binary that suits your OS and CPU architecture. For example, in the case of Linux (amd64), you can install the MimixBox and documents on your system with the following command:

$ tar xf mimixbox-0.30.0-linux-amd64.tar.gz
$ cd mimixbox-0.30.0-linux-amd64
$ sudo ./installer.sh

Use "go install"

$ go install github.com/nao1215/mimixbox/cmd/mimixbox@latest
$ sudo mimixbox --install /usr/local/bin

Use homebrew

$ brew install nao1215/tap/mimixbox

Development

Tools & Libraries

The table below shows the tools used when developing the commands in the MimixBox project.

Tool description
go-licenses Used for license management of dependent libraries
pandoc Convert markdown files to manpages
make Used for build, test, release, etc
gzip Used for compress man pages
curl Used for install ShellSpec
install Used for install MimixBox binary and document in the system
docker Used for testing Mimixbox inside Docker
debootstrap Used for testing Mimixbox inside jail envrioment
shellspec Used for integration test
libpam0g-dev(pam-devel) PAM (Pluggable Authentication Modules) library

If you use Debian-based distribution (e.g. Debian／Ubuntu／Kali Linux／Raspberry Pi OS), You can install tools with the following command.

$ sudo apt install build-essential curl git pandoc gzip docker.io debootstrap libpam0g-dev
$ go install github.com/google/go-licenses@latest
$ curl -fsSL https://git.io/shellspec | sh -s -- --yes

How to build

$ git clone https://github.com/nao1215/mimixbox.git
$ cd mimixbox
$ make build

Debugging

How to create docker environment

$ make docker

※ Once the Docker image build is complete, you'll be inside the container.
$

How to create jail environment

$ sudo apt install debootstrap    ※ If you have not installed debootstrap in Ubuntu.
$ make build                      ※ Build mimixbox binary
$ sudo make jail                  ※ Create jail environment at /tmp/mimixbox/jail

$ sudo chroot /tmp/mimixbox/jail /bin/bash   ※ Dive to jail
# mimixbox --full-install /usr/local/bin     ※ Install MimixBox's command in jail

Roadmap

  • Step1. Implements many common Unix commands (〜Version 0.x.x).
  • Step2. Increase the options for each commands (〜Version 1.x.x).
  • Step3. Change the command to modern specifications(〜Version 2.x.x)

Now, MimixBox has not implemented enough commands (currently supported command list is here). Therefore, as a project, we will increase the number of commands and aim for a state where dog fooding can be done with the highest priority.

Then increase the command options to the same level as Coreutils and other packages. Note that MimixBox does not aim to create commands equivalent to Coreutils. However, we think it's better to have the options that Linux users expect.

Finally, it's the phase that makes the Mimix Box unique. Extend commands to high functionality, like bat and lsd, which are reimplementations of cat and ls.

Original commands in MimixBox

MimixBox has its own commands that don't exist in packages like Coreutils.

Command (Applet) Name Description
fakemovie Adds a video playback button to the image
ghrdc GitHub Relase Download Counter
path Manipulate filename path
sddf Search & Delete Dupulicated File
serial Rename the file to the name with a serial number

Contributing

First off, thanks for taking the time to contribute! ❤️ See CONTRIBUTING.md for more information. Contributions are not only related to development. For example, GitHub Star motivates me to develop! Star History Chart

Contact

If you would like to send comments such as "find a bug" or "request for additional features" to the developer, please use one of the following contacts. We are also looking forward to sponsorship.

LICENSE

The MimixBox project is licensed under the terms of the MIT license and Apache License 2.0.
See LICENSE and NOTICE

Contributors ✨

Thanks goes to these wonderful people (emoji key):

CHIKAMATSU Naohiro
CHIKAMATSU Naohiro
💻		 polynomialspace
polynomialspace
💻		 Kavya Shukla
Kavya Shukla
💻
Add your contributions

This project follows the all-contributors specification. Contributions of any kind welcome!