Fork me on GitHub Last updated: 2020-02-08


Command list

--help Alias for `plash help`
--help-macros Alias for `plash help-macros`
--version Alias for `plash version`
-h Alias for `plash help`
add-layer Stack a layer on top of a container
b Build then run utility
build Builds a container
clean Cleanup internal states
copy Copy the container's root filesystem to directory
create Creates a new container from a command
data Prints the location of the build data
eval Generates a build script
export-tar Export container as tar archive
help Prints help
help-macros Lists all available macros
import-docker Import image from local docker instance into
import-lxc Import an image from https://images
import-tar Create a container from a tar file
import-url Import a container from an url
init Initialize build data
map Map a container to a key
mkdtemp Create a temporary directory in the plash data
mount Mount a container-filesystem
nodepath Prints the path to a given container
parent Prints the containers parent container
purge Deletes all build data unatomically
rm Deletes the given container atomically
run Run a container
runopts Run a container specifying lower level options
shallow-copy Copy and hard link the filesystem to OUT
shrink Delete half of the older containers
sudo Setup a Linux user namespace
test Run unit tests
version Prints the version number
with-mount Execute parameters inside a mounted container
-* Fallback to `plash b run`

Command Dependencies

Build commands ("macros")

hint Write a hint for consumer programs
import Import macros from any python module
reset-imports Unimport all imported macros but builtins
entrypoint Hint default command for this build
entrypoint-script Write lines to /entrypoint and hint it as default command
eval-file Evaluate file content as expressions
eval-github Eval a file (default 'plashfile') from a github repo
eval-stdin Evaluate expressions read from stdin
eval-string Evaluate expressions passed as string
hash-path Recursively hash files and add as cache key
import-env Import environment variables from host
inline Emit all arguments in one line
invalidate-layer Invalidate the cache of the current layer
layer Hints the start of a new layer
run Directly emit shell script
run-stdin Run commands read from stdin
write-file Write lines to a file
write-script Write an executable (755) file to the filesystem
from Guess from where to take the image
from-docker Use image from local docker
from-github Build and use a file (default 'plashfile') from a github repo
from-id Specify the image from an image id
from-lxc Use images from
from-map Use resolved map as image
from-url Import image from an url
add-apt-repository Install packages with add-apt-repository
apk Install packages with apk
apt Install packages with apt
defpm Define a new package manager
dnf Install packages with dnf
emerge Install packages with emerge
npm Install packages with npm
pacman Install packages with pacman
pip Install packages with pip
pip3 Install packages with pip3
yum Install packages with yum
A Alias for: --from alpine:edge --apk [arg1 [arg2 [...]]]
C Alias for: --from centos:8 --yum [arg1 [arg2 [...]]]
D Alias for: --from debian:sid --apt [arg1 [arg2 [...]]]
F Alias for: --from fedora:31 --dnf [arg1 [arg2 [...]]]
G Alias for: --from gentoo:current --emerge [arg1 [arg2 [...]]]
R Alias for: --from archlinux:current --pacman [arg1 [arg2 [...]]]
U Alias for: --from ubuntu:bionic --apt [arg1 [arg2 [...]]]
f Alias for: --from [arg1 [arg2 [...]]]
l Alias for: --layer [arg1 [arg2 [...]]]
x Alias for: --run [arg1 [arg2 [...]]]


Image editing with gimp

$ plash build --from alpine --apk ttf-ubuntu-font-family gimp --layer --run 'touch /myfile'
$ plash run 112 gimp

Run python scripts

plash --from-github ihucos/python -- python

Integration with docker

plash export-tar --from alpine | docker import -
plash --from-docker busybox

Manage your dotfiles

plash -A py3-pip --layer --pip3 dotfiles -- dotfiles --sync

User namespaces

$ whoami
$ plash sudo whoami

Fetch a container image

$ plash build --from alpine
plash: fetching 100%
plash: extracting...
plash: ignoring dev file: ./dev/null (Operation not permitted)

Run something in a container

$ plash run 2 printf 'hello from container\n'
hello from container

Automatic filesystem mapping

$ mkdir ~/mydir
$ cd ~/mydir
$ plash run 2 pwd

Add layer to existing container

$ plash build --from 2 --run 'touch /myfile'
+ touch /myfile

Build and run in one command

$ plash b run --from alpine --run 'touch /myfile' -- ls /myfile

Shorter invocation

$ plash -Ax 'touch /myfile' -- ls /myfile

Explicit layering

$ plash -Ax 'touch /myfile' -lx 'touch /otherfile' -- ls /otherfile 

Access container root filesystem

$ plash b with-mount -A -- ls
bin  dev  etc  home  lib  media  mnt  proc  root  run  sbin  srv  sys  tmp  usr  var

Remove last layer of an image

$ plash b rm --from-github ihucos/python

Create an executable build file

$ cat /tmp/yapf
#!/usr/bin/env plash-exec
--from-github ihucos/python
--pip3 yapf
--entrypoint /usr/bin/yapf
$ /tmp/yapf myproject

Example of a more complex executable build file

#!/usr/bin/env plash-exec
--from archlinux
--pacman gtk3 python-gobject
#!/usr/bin/env python
import gi
gi.require_version('Gtk', '3.0')
from gi.repository import Gtk
Hello = Gtk.MessageDialog(message_type=Gtk.MessageType.INFO,
                          text="Hello world!",
                          secondary_text="This is running inside a plash container.")

Macros expand to shell code

$ plash eval --from ubuntu --apt python3-pip --layer --pip3 yapf -lx 'touch /foo'
### plash hint: image=9
apt-get update
apt-get install -y python3-pip
### plash hint: layer
pip3 install yapf
### plash hint: layer
touch /foo