toolbox-enter.1.md

% toolbox-enter 1

NAME

toolbox-enter - Enter a Toolbx container for interactive use

SYNOPSIS

toolbox enter [--container NAME | -c NAME] [--distro DISTRO | -d DISTRO] [--release RELEASE | -r RELEASE] [CONTAINER]

DESCRIPTION

Spawns an interactive shell inside a Toolbx container that was created using the toolbox create command. It tries to spawn the user's login shell, but if it's not available inside the container then it falls back to /bin/bash.

When invoked without any options, toolbox enter will try to enter the default Toolbx container for the host, or if there's only one container available then it will use it. On Fedora, the default container is known as fedora-toolbox-N, where N is the release of the host. If there aren't any containers, toolbox enter will offer to create the default one for you.

A specific container can be selected using the CONTAINER argument.

A Toolbx container is an OCI container. Therefore, toolbox enter is analogous to a podman start followed by a podman exec.

OPTIONS

The following options are understood:

--container NAME, -c NAME

Enter a Toolbx container with the given NAME. This option is an alternative to the positional CONTAINER argument. If both are provided, the positional argument takes precedence.

--distro DISTRO, -d DISTRO

Enter a Toolbx container for a different operating system DISTRO than the host. Has to be coupled with --release unless the selected DISTRO matches the host.

--release RELEASE, -r RELEASE

Enter a Toolbx container for a different operating system RELEASE than the host.

EXAMPLES

Enter the default Toolbx container matching the host OS

$ toolbox enter

Enter the default Toolbx container for Fedora 36

$ toolbox enter --distro fedora --release f36

Enter a Toolbx container with a custom name

$ toolbox enter foo

SEE ALSO

toolbox(1), toolbox-run(1), podman(1), podman-exec(1), podman-start(1)