mimixbox

module

v0.32.1 Latest Latest Go to latest Published: Dec 19, 2021 License: Apache-2.0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/nao1215/mimixbox

Links

Open Source Insights

README ¶

GitHub GitHub all releases Lines of code

[日本語]

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

If you have a Golang development environment, you can also install it by the following method. This method does not install the documentation.

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

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

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.

GitHub Issue
Twitter@mimixbox156 ※ MimixBox project information
Patreon

LICENSE

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

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
cmd
mimixbox mimixbox/cmd/mimixbox/main.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/cmd/mimixbox/main.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
internal
applets mimixbox/internal/applets/applet.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/applet.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/archival/gzip mimixbox/internal/applets/console-tools/gzip/gzip.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/console-tools/gzip/gzip.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/console-tools/clear mimixbox/internal/applets/console-tools/clear/clear.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/console-tools/clear/clear.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/console-tools/reset mimixbox/internal/applets/console-tools/reset/reset.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/console-tools/reset/reset.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/debianutils/add-shell mimixbox/internal/applets/debianutils/add-shell/add-shell.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/debianutils/add-shell/add-shell.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/debianutils/ischroot mimixbox/internal/applets/debianutils/ischroot/ischroot.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/debianutils/ischroot/ischroot.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/debianutils/remove-shell mimixbox/internal/applets/debianutils/remove-shell/remove-shell.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/debianutils/remove-shell/remove-shell.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/debianutils/which mimixbox/internal/applets/debianutils/which/which.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/debianutils/which/which.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/fileutils/chgrp mimixbox/internal/applets/fileutils/chgrp/chgrp.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/fileutils/chgrp/chgrp.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/fileutils/chown mimixbox/internal/applets/fileutils/chown/chown.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/fileutils/chown/chown.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/fileutils/cp mimixbox/internal/applets/fileutils/cp/cp.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/fileutils/cp/cp.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/fileutils/ln mimixbox/internal/applets/fileutils/ln/ln.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/fileutils/ln/ln.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/fileutils/mkdir mimixbox/internal/applets/fileutils/mkdir/mkdir.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/fileutils/mkdir/mkdir.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/fileutils/mkfifo mimixbox/internal/applets/fileutils/mkfifo/mkfifo.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/fileutils/mkfifo/mkfifo.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/fileutils/mv mimixbox/internal/applets/fileutils/mv/mv.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/fileutils/mv/mv.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/fileutils/rm mimixbox/internal/applets/fileutils/rm/rm.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/fileutils/rm/rm.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/fileutils/rmdir mimixbox/internal/applets/fileutils/rmdir/rmdir.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/fileutils/rmdir/rmdir.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/fileutils/touch mimixbox/internal/applets/fileutils/touch/touch.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/fileutils/touch/touch.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/jokeutils/cowsay mimixbox/internal/applets/jokeutils/cowsay/cowsay.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/jokeutils/cowsay/cowsay.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/jokeutils/fakemovie mimixbox/internal/applets/jokeutils/fakemovie/fakemovie.go Copyright © 2021 by Yasuhiro Matsumoto (a.k.a.	mimixbox/internal/applets/jokeutils/fakemovie/fakemovie.go Copyright © 2021 by Yasuhiro Matsumoto (a.k.a.
applets/jokeutils/sl mimixbox/internal/applets/shellutils/sl/cowsay.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/shellutils/sl/cowsay.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/loginutils/chsh mimixbox/internal/applets/loginutils/chsh/chsh.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/loginutils/chsh/chsh.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/mbutils/ghrdc mimixbox/internal/applets/mbutils/ghrdc/ghrdc.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/mbutils/ghrdc/ghrdc.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/mbutils/mbsh mimixbox/internal/applets/mbutils/mbsh/sh.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/mbutils/mbsh/sh.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/mbutils/mbsh/builtin mimixbox/internal/applets/mbutils/mbsh/builtin/buitInCmds.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/mbutils/mbsh/builtin/buitInCmds.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/mbutils/path mimixbox/internal/applets/mbutils/path/path.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/mbutils/path/path.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/mbutils/sddf mimixbox/internal/applets/mbutils/sddf/sddf.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/mbutils/sddf/sddf.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/mbutils/serial mimixbox/internal/applets/mbutils/serial/serial.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/mbutils/serial/serial.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/mbutils/valid-shell mimixbox/internal/applets/debianutils/valid-shell/valid-shell.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/debianutils/valid-shell/valid-shell.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/pmutils/halt mimixbox/internal/applets/pmutils/halt/halt.go Copyright 2021 Naohiro CHIKAMATSU, polynomialspace Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/pmutils/halt/halt.go Copyright 2021 Naohiro CHIKAMATSU, polynomialspace Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/shellutils/base64 mimixbox/internal/applets/shellutils/base64/base64.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/shellutils/base64/base64.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/shellutils/basename mimixbox/internal/applets/shellutils/basename/basename.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/shellutils/basename/basename.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/shellutils/chroot mimixbox/internal/applets/shellutils/chroot/chroot.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/shellutils/chroot/chroot.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/shellutils/dirname mimixbox/internal/applets/shellutils/dirname/dirname.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/shellutils/dirname/dirname.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/shellutils/echo mimixbox/internal/applets/shellutils/echo/echo.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/shellutils/echo/echo.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/shellutils/false mimixbox/internal/applets/shellutils/false/false.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/shellutils/false/false.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
applets/shellutils/groups mimixbox/internal/applets/shellutils/groups/groups.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.	mimixbox/internal/applets/shellutils/groups/groups.go Copyright 2021 Naohiro CHIKAMATSU Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.