Tool for interactive command line environments on Linux
Find a file
Debarshi Ray 5d26b9d71d build: Enable changing the completion paths & drop install_completions
The bash-completion and fish dependencies were already optional - the
shell completions for Bash and fish won't be generated and installed if
they are absent; and there's no dependency required for Z shell.  So the
install_completions build option wasn't reducing the dependency burden.

The build option was a way to disable the generation and installation of
the shell completions, regardless of whether the necessary dependencies
are present or not.  The only use-case for this is when installing to a
non-system-wide prefix while hacking on Toolbox as a non-root user,
because the locations for the completions advertised by the shells' APIs
might not be accessible.  Being able to disable the completions prevents
the installation from failing.

A different way of ensuring a smooth developer experience for a Toolbx
hacker is to offer a way to change the locations where the shell
completions are installed, which is necessary and beneficial for other
use-cases.

Z shell, unlike Bash's bash-completion.pc and fish's fish.pc, doesn't
offer an API to detect the location for the shell completions.  This
means that Debian and Fedora use different locations [1, 2].  Namely,
/usr/share/zsh/vendor-completions and /usr/share/zsh/site-functions.

An option to specify the locations for the shell completions can
optimize the build, if there's an alternate API for the location that
doesn't involve using bash-completion.pc and fish.pc as build
dependencies.  eg., Fedora provides the _tmpfilesdir RPM macro to
specify the location for vendor-supplied tmpfiles.d(5) files, which
makes it possible to avoid having systemd.pc as a build dependency [3].

Fallout from bafbbe81c9

[1] Debian zsh commit bf0a44a8744469b5
    https://salsa.debian.org/debian/zsh/-/commit/bf0a44a8744469b5
    https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=620452

[2] https://src.fedoraproject.org/rpms/zsh/blob/f37/f/zsh.spec

[3] Fedora toolbox commit 9bebde5bb60f36e3
    https://src.fedoraproject.org/rpms/toolbox/c/9bebde5bb60f36e3

https://github.com/containers/toolbox/pull/1123
https://github.com/containers/toolbox/pull/840
2022-10-21 16:42:29 +02:00
.github Revert "ci: Build & Publish Fedora Toolbx images with GitHub Packages" 2022-03-20 21:11:32 +02:00
completion build: Enable changing the completion paths & drop install_completions 2022-10-21 16:42:29 +02:00
data README: Flip the graphic's facing direction for better layout 2022-01-13 21:22:23 +01:00
doc doc/toolbox-create: Mention the file format accepted by --authfile 2022-09-07 17:02:56 +02:00
images Add corrections to avoid duplicate packages 2022-10-20 07:15:34 -04:00
playbooks playbooks: Make all Meson warnings fatal 2022-08-31 19:35:05 +02:00
profile.d build: Tweak the names of the ShellCheck tests 2022-09-09 17:16:25 +02:00
src build: Don't try to handle exceptions when spawning subprocesses 2022-09-09 18:35:55 +02:00
test/system test/system: Drop extra pull when caching images 2022-09-21 14:49:21 +02:00
.gitignore test/system: Track bats libs as submodules & install them better 2021-07-22 10:23:53 +02:00
.gitmodules test/system: Track bats libs as submodules & install them better 2021-07-22 10:23:53 +02:00
.mailmap .mailmap: Canonicalize my email 2022-08-01 18:37:43 +02:00
.zuul.yaml .zuul, playbooks: Run unit tests on -Dmigration_path_for_coreos_toolbox 2022-08-31 13:42:40 +02:00
CODE-OF-CONDUCT.md Add Code of Conduct 2020-02-12 17:12:23 +01:00
CONTRIBUTING.md CONTRIBUTING: Custom graphic 2022-01-07 09:34:39 +01:00
COPYING Rename LICENSE as COPYING 2018-10-19 18:24:23 +02:00
gen-docs-list gen-docs-list: Add newline at end of file 2021-02-08 16:49:58 +01:00
GOALS.md GOALS.md: Cosmetics 2021-01-25 21:13:07 +01:00
meson.build build: Enable changing the completion paths & drop install_completions 2022-10-21 16:42:29 +02:00
meson_options.txt build: Enable changing the completion paths & drop install_completions 2022-10-21 16:42:29 +02:00
meson_post_install.py build: Remove a redundant message 2022-09-09 18:36:02 +02:00
NEWS Prepare 0.0.99.3 2021-12-10 03:40:42 +01:00
README.md Generate & install completion scripts in build system 2022-02-21 15:15:30 +02:00
SECURITY.md Add Security Policy 2020-05-13 14:37:08 +02:00
toolbox Link to the installation guide from the shell Toolbox 2022-08-29 22:09:15 +02:00

README

Zuul Daily Pipeline

Arch Linux package Fedora package

Toolbox is a tool for Linux operating systems, which allows the use of containerized command line environments. It is built on top of Podman and other standard container technologies from OCI.

This is particularly useful on OSTree based operating systems like Fedora CoreOS and Silverblue. The intention of these systems is to discourage installation of software on the host, and instead install software as (or in) containers — they mostly don't even have package managers like DNF or YUM. This makes it difficult to set up a development environment or install tools for debugging in the usual way.

Toolbox solves this problem by providing a fully mutable container within which one can install their favourite development and debugging tools, editors and SDKs. For example, it's possible to do yum install ansible without affecting the base operating system.

However, this tool doesn't require using an OSTree based system. It works equally well on Fedora Workstation and Server, and that's a useful way to incrementally adopt containerization.

The toolbox environment is based on an OCI image. On Fedora this is the fedora-toolbox image. This image is used to create a toolbox container that seamlessly integrates with the rest of the operating system by providing access to the user's home directory, the Wayland and X11 sockets, networking (including Avahi), removable devices (like USB sticks), systemd journal, SSH agent, D-Bus, ulimits, /dev and the udev database, etc..

Installation & Use

See our guides on installing & getting started with Toolbox and Linux distro support.