Methods
Method new()
Create a new Dockerfile object.
Arguments
FROMThe base image.
ASThe name of the image.
Returns
A Dockerfile object.
Method RUN()
Add a RUN command.
Returns
the Dockerfile object, invisibly.
Method ADD()
Add a ADD command.
Arguments
fromThe source file.
toThe destination file.
forceIf TRUE, overwrite the destination file.
Returns
the Dockerfile object, invisibly.
Method COPY()
Add a COPY command.
Arguments
fromThe source file.
toThe destination file.
stageOptional. Name of the build stage (e.g., "builder") to copy files from. This corresponds to the --from= part in a Dockerfile COPY instruction (e.g., COPY --from=builder /source /dest). If NULL, the --from= argument is omitted.
forceIf TRUE, overwrite the destination file.
Returns
the Dockerfile object, invisibly.
Method WORKDIR()
Add a WORKDIR command.
Arguments
whereThe working directory.
Returns
the Dockerfile object, invisibly.
Method EXPOSE()
Add a EXPOSE command.
Returns
the Dockerfile object, invisibly.
Method VOLUME()
Add a VOLUME command.
Arguments
volumeThe volume to add.
Returns
the Dockerfile object, invisibly.
Method CMD()
Add a CMD command.
Returns
the Dockerfile object, invisibly.
Method LABEL()
Add a LABEL command.
Arguments
key, valueThe key and value of the label.
Returns
the Dockerfile object, invisibly.
Method ENV()
Add a ENV command.
Arguments
key, valueThe key and value of the label.
Returns
the Dockerfile object, invisibly.
Method ENTRYPOINT()
Add a ENTRYPOINT command.
Returns
the Dockerfile object, invisibly.
Method USER()
Add a USER command.
Returns
the Dockerfile object, invisibly.
Method ARG()
Add a ARG command.
Arguments
argThe argument to add.
aheadIf TRUE, add the argument at the beginning of the Dockerfile.
Returns
the Dockerfile object, invisibly.
Method ONBUILD()
Add a ONBUILD command.
Returns
the Dockerfile object, invisibly.
Method STOPSIGNAL()
Add a STOPSIGNAL command.
Arguments
signalThe signal to add.
Returns
the Dockerfile object, invisibly.
Method HEALTHCHECK()
Add a HEALTHCHECK command.
Returns
the Dockerfile object, invisibly.
Method SHELL()
Add a SHELL command.
Returns
the Dockerfile object, invisibly.
Method MAINTAINER()
Add a MAINTAINER command.
Arguments
name, emailThe name and email of the maintainer.
Returns
the Dockerfile object, invisibly.
Method custom()
Add a custom command.
Arguments
base, cmdThe base and command to add.
Returns
the Dockerfile object, invisibly.
Add a comment.
Arguments
commentThe comment to add.
Returns
the Dockerfile object, invisibly.
Print the Dockerfile.
Returns
used for side effect
Write the Dockerfile to a file.
Arguments
asThe file to write to.
appendboolean, if TRUE append to file.
Returns
used for side effect
Method switch_cmd()
Switch commands.
Arguments
a, bThe commands to switch.
Returns
the Dockerfile object, invisibly.
Method remove_cmd()
Remove a command.
Arguments
whereThe commands to remove.
Returns
the Dockerfile object, invisibly.
Method add_after()
Add a command after another.
Arguments
cmdThe command to add.
afterWhere to add the cmd
Returns
the Dockerfile object, invisibly.
Method clone()
The objects of this class are cloneable with this method.
Arguments
deepWhether to make a deep clone.