Command line usage

kas - setup tool for bitbake based project

usage: kas [-h] [--version] [-d] [-l {debug,info,warning,error,critical}]
           {build,checkout,dump,for-all-repos,shell,menu} ...

Positional Arguments

cmd

Possible choices: build, checkout, dump, for-all-repos, shell, menu

sub command help

Named Arguments

--version

show program’s version number and exit

-d, --debug

Enable debug logging (deprecated, use –log-level debug).

-l, --log-level

Possible choices: debug, info, warning, error, critical

Set log level (default: info)

Default: “info”

Environment variables

Environment variables

Description

KAS_WORK_DIR

The path of the kas work directory, current work directory is the default.

KAS_BUILD_DIR

The path build directory, ${KAS_WORK_DIR}/build is the default.

KAS_REPO_REF_DIR

The path to the repository reference directory. Repositories in this directory are used as references when cloning. In order for kas to find those repositories, they have to be named in a specific way. The repo URLs are translated like this: “https://github.com/siemens/meta-iot2000.git” resolves to the name “github.com.siemens.meta-iot2000.git”. Repositories that are not found will be cloned below this directory. Multiple instances of kas can simultaneously work on the same directory, as long as the underlying filesystem is POSIX compatible.

KAS_DISTRO KAS_MACHINE KAS_TARGET KAS_TASK

This overwrites the respective setting in the configuration file.

KAS_PREMIRRORS DISTRO_APT_PREMIRRORS

Specifies alternatives for repo URLs. Just like bitbake PREMIRRORS, this variable consists of new-line separated entries. Each entry defines a regular expression to match a URL and, space-separated, its replacement. E.g.: “http://.*.someurl.io/ http://localmirror.net/

SSH_PRIVATE_KEY

Variable containing the private key that should be added to an internal ssh-agent. This key cannot be password protected. This setting is useful for CI build servers. On desktop machines, an ssh-agent running outside the kas environment is more useful.

SSH_PRIVATE_KEY_FILE

Path to the private key file that should be added to an internal ssh-agent. This key cannot be password protected. This setting is useful for CI build servers. On desktop machines, an ssh-agent running outside the kas environment is more useful.

SSH_AUTH_SOCK

SSH authentication socket. Used for cloning over SSH (alternative to SSH_PRIVATE_KEY or SSH_PRIVATE_KEY_FILE).

DL_DIR SSTATE_DIR SSTATE_MIRRORS TMPDIR

Environment variables that are transferred to the bitbake environment.

http_proxy https_proxy ftp_proxy no_proxy

These variables define the proxy configuration bitbake should use.

GIT_PROXY_COMMAND NO_PROXY

Set proxy for native git fetches. NO_PROXY is evaluated by OpenEmbedded’s oe-git-proxy script.

SHELL

The shell to start when using the shell plugin.

TERM

The terminal options used in the shell plugin.

AWS_CONFIG_FILE AWS_ROLE_ARN AWS_SHARED_CREDENTIALS_FILE AWS_WEB_IDENTITY_TOKEN_FILE

Path to the awscli configuration and credentials files that are copied to the kas home dir.

GIT_CREDENTIAL_HELPER GIT_CREDENTIAL_USEHTTPPATH

Allows to set and configure the git credential helper in the .gitconfig of the kas user.

GITCONFIG_FILE

Path to a .gitconfig file which will be copied to the kas home dir as .gitconfig.

NETRC_FILE

Path to a .netrc file which will be copied to the kas home dir as .netrc.

CI_SERVER_HOST CI_JOB_TOKEN

Environment variables from gitlab CI, if set .netrc is configured to allow fetching from the gitlab instance. An entry will be appended in case NETRC_FILE was given as well. Note that if the file already contains an entry for that host most tools would probably take that first one.

GITHUB_ACTIONS

Environment variables from github actions. If set to true, .gitconfig is automatically imported. For details, see GITCONFIG_FILE.

BB_NUMBER_THREADS PARALLEL_MAKE

Environment variables to control the concurrency

For details about the access of remote resources, see Credential Handling.