particle-os/debian-forge
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

README.md: Add section about running osbuild

Browse source
This commit is contained in:
Lars Karlitski 2019-04-09 18:41:59 +02:00
parent ced6d2887a
commit 4f2eef837d
1 changed files with 10 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -40,3 +40,13 @@ pid namespaces. It injects the `options` object with a `tree` key pointing to
the file system tree and passes that to the stage via its `stdin`.
Stages may have side effects: the `io.weldr.qcow2` stage in the above example
packs the tree into a `qcow2` image.
## Running
```
osbuild [--from ARCHIVE] [--save ARCHIVE] PIPELINE
```
Runs `PIPELINE`. If `--from` is given, unpacks its contents (`.tar.gz`) into
the tree before running the first stage. If `--save` is given, saves the
contents of the tree in the given archive.