.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "KAS-CHECKOUT" "1" "Apr 10, 2024" "4.3.2" "kas"
.SH NAME
kas-checkout \- kas checkout plugin
.sp
This plugin implements the \fBkas checkout\fP command.
.sp
When this command is executed, kas will checkout repositories and set up
the build directory as specified in the chosen config file. This command
is useful if you need to inspect the configuration or modify any of the
checked out layers before starting a build.
.sp
For example, to setup the configuration described in the file
\fBkas\-project.yml\fP you could run:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
kas checkout kas\-project.yml
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.EX
usage: kas checkout [\-h] [\-\-skip SKIP] [\-\-force\-checkout] [\-\-update] [config]
.EE
.UNINDENT
.UNINDENT
.SH POSITIONAL ARGUMENTS
.INDENT 0.0
.TP
.B config
Config file(s), separated by colon. Using .config.yaml in KAS_WORK_DIR if none is specified.
.UNINDENT
.SH NAMED ARGUMENTS
.INDENT 0.0
.TP
.B \-\-skip
Skip build steps
.sp
Default: []
.TP
.B \-\-force\-checkout
Always checkout the desired commit/branch/tag of each repository, discarding any local changes
.sp
Default: False
.TP
.B \-\-update
Pull new upstream changes to the desired branch even if it is already checked out locally
.sp
Default: False
.UNINDENT
.SH KAS
.sp
Part of the \fBkas(1)\fP suite.
.SH AUTHOR
Daniel Wagner, Jan Kiszka, Claudius Heine
.SH COPYRIGHT
Siemens AG, 2017-2024
.\" Generated by docutils manpage writer.
.