2019-02-28 17:07:24 +00:00
|
|
|
% toolbox(1)
|
|
|
|
|
|
|
|
## NAME
|
|
|
|
toolbox - Unprivileged development environment
|
|
|
|
|
|
|
|
## SYNOPSIS
|
|
|
|
**toolbox** [*--verbose* | *-v*] *COMMAND* [*ARGS*]
|
|
|
|
|
|
|
|
## DESCRIPTION
|
|
|
|
|
|
|
|
Toolbox is a tool that offers a familiar RPM based environment for developing
|
|
|
|
and debugging software that runs fully unprivileged using Podman.
|
|
|
|
|
|
|
|
The toolbox container is a fully *mutable* container; when you see
|
|
|
|
`yum install ansible` for example, that's something you can do inside your
|
|
|
|
toolbox container, without affecting the base operating system.
|
|
|
|
|
|
|
|
This is particularly useful on OSTree based Fedora systems like Silverblue.
|
|
|
|
The intention of these systems is to discourage installation of software on
|
|
|
|
the host, and instead install software as (or in) containers.
|
|
|
|
|
|
|
|
However this tool doesn't *require* using an OSTree based system — it works
|
|
|
|
equally well if you're running e.g. existing Fedora Workstation or 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 then customized for the current user to
|
|
|
|
create a toolbox container that seamlessly integrates with the rest of the
|
|
|
|
operating system.
|
|
|
|
|
|
|
|
## OPTIONS ##
|
|
|
|
|
|
|
|
The following options are understood:
|
|
|
|
|
2019-04-26 16:28:11 +00:00
|
|
|
**--assumeyes, -y**
|
|
|
|
|
|
|
|
Automatically answer yes for all questions.
|
|
|
|
|
2019-02-28 17:07:24 +00:00
|
|
|
**--help, -h**
|
|
|
|
|
|
|
|
Print a synopsis of this manual and exit.
|
|
|
|
|
|
|
|
**--verbose, -v**
|
|
|
|
|
2019-09-04 11:06:19 +00:00
|
|
|
Print debug information including standard error stream of internal commands.
|
2019-10-08 06:42:42 +00:00
|
|
|
Use `-vv` for more detail.
|
2019-02-28 17:07:24 +00:00
|
|
|
|
|
|
|
## COMMANDS
|
|
|
|
|
|
|
|
Commands for working with toolbox containers and images:
|
|
|
|
|
|
|
|
**toolbox-create(1)**
|
|
|
|
|
|
|
|
Create a new toolbox container.
|
|
|
|
|
|
|
|
**toolbox-enter(1)**
|
|
|
|
|
2019-05-16 12:40:17 +00:00
|
|
|
Enter a toolbox container for interactive use.
|
2019-02-28 17:07:24 +00:00
|
|
|
|
2019-07-15 08:23:25 +00:00
|
|
|
**toolbox-help(1)**
|
|
|
|
|
|
|
|
Display help information about Toolbox.
|
|
|
|
|
2019-05-10 18:38:46 +00:00
|
|
|
**toolbox-init-container(1)**
|
|
|
|
|
|
|
|
Initialize a running container.
|
|
|
|
|
2019-02-28 17:07:24 +00:00
|
|
|
**toolbox-list(1)**
|
|
|
|
|
|
|
|
List existing toolbox containers and images.
|
|
|
|
|
2019-02-19 15:59:19 +00:00
|
|
|
**toolbox-rm(1)**
|
|
|
|
|
|
|
|
Remove one or more toolbox containers.
|
|
|
|
|
|
|
|
**toolbox-rmi(1)**
|
|
|
|
|
|
|
|
Remove one or more toolbox images.
|
|
|
|
|
2019-05-16 12:40:17 +00:00
|
|
|
**toolbox-run(1)**
|
|
|
|
|
|
|
|
Run a command in an existing toolbox container.
|
|
|
|
|
2019-02-28 17:07:24 +00:00
|
|
|
## SEE ALSO
|
|
|
|
|
|
|
|
`buildah(1)`, `podman(1)`
|