KAS-DUMP(1)

📦
version 5.4 · 3 versions
, in ubuntu stonking

💅 KAS-DUMP — the kas dump plugin, bestie edition ✨

okay so bestie, welcome to kas-dump(1), part of the kas manual. this is the page that tells you everything about the kas dump plugin, and yeah we're gonna go through all of it, no skips, no cap. 🫶

✨ SYNOPSIS ✨

kas dump [-h] [--skip STEP] [--force-checkout] [--update] [--indent INDENT]
         [--sort] [--format {yaml,json}] [--resolve-refs] [--resolve-local]
         [--resolve-env | --lock]
         [config]

🌸 DESCRIPTION 🌸

So what does this actually do? It expands and dumps the final config to stdout. Obsessed. And lowkey important: when it's resolving branches, it does that before patches get applied. iykyk.

This plugin is literally the implementation of the kas dump command. 💁‍♀️

🎀 default mode vibes

When you run this command in default mode, kas will parse every referenced config file, expand all the includes, and print a flattened yaml version of the configuration straight to stdout. That config is semantically identical to the input — but it does not include any references to other configuration files. So you can take that output and go analyze your build configuration further. slay. ✨

🔒 --lock mode

When you run it with --lock, a locking spec gets created that only contains the exact commit of each repository. This is the moment for pinning the commit of floating branches and tags while still keeping an easy update path. iconic behavior honestly.

For all the deets on locking support, see kas.plugins.lock <#module-kas.plugins.lock>. 👑

Note: the options to create and update lock files have been moved to the lock plugin. not me finding out they relocated 💀

🦋 --resolve-local mode

When you run it with --resolve-local, VCS tracking information of the root repo (that's the one with the kas-project.yml) gets added to the output. The generated file can be used as a single input to kas to reproduce the build environment. so handy fr fr.

If the root repo is not under version control, or it contains uncommitted changes, a warning is emitted. ⚠️ heads up bestie.

💖 please note:

  • the dumped config is semantically identical but not bit-by-bit identical
  • all referenced repositories are checked out to resolve cross-repo configs
  • all branches are resolved before patches are applied
  • the ordering of the keys is kept unless --sort is used. If you intend to store the flattened configs for comparison, it is recommended to sort the keys. trust.

🌈 example time

say you want a single config representing the final build config of kas-project.yml:target-override.yml — you'd run:

kas dump kas-project.yml:target-override.yml > kas-project-expanded.yml

and then the generated config can be used as input for kas:

kas build kas-project-expanded.yml

like?? it's giving full circle. 💫

💅 OPTIONS 💅

Positional Arguments

  • config — the config file(s), separated by a colon. If you don't specify any, it uses .config.yaml in KAS_WORK_DIR. ✨

Named Arguments

  • --skip=[] — skip build steps. Wanna skip more than one step? use this argument multiple times, bestie. Possible choices: setup_dir, setup_home, make_non_interactive, init_setup_repos, repo_setup_loop, finish_setup_repos, repos_checkout, repos_apply_patches, setup_environ, write_bbconfig
  • --force-checkout=False — always checkout the desired commit/branch/tag of each repository, and discard any local changes. no mercy. 🔥
  • --update=False — pull new upstream changes to the desired branch even if it's already checked out locally. fresh vibes only.
  • --indent=2 — line indent, as a number of spaces. default is 2.
  • --sort=False — alphanumerically sort the keys in the output. so tidy. 🧚
  • --format='yaml' — output format. default is yaml. Possible choices: yaml, json
  • --resolve-refs=False — replace floating refs with exact SHAs. Overrides are removed. 👑
  • --resolve-local=False — add tracking information of the root repo.
  • --resolve-env=False — set env defaults to the captured env value.
  • --lock=False — create a lockfile with exact SHAs. 🔒

👀 SEE ALSO 👀

kas-project-config(1), kas-checkout(1), kas-lock(1), kas-build(1)

🌟 KAS 🌟

Part of the kas(1) suite. one big happy family fr.

Author: Daniel Wagner, Jan Kiszka, Claudius Heine 💖

Copyright: Siemens and contributors, 2017-2025 ⭐

and that's the whole page, bestie!! this was version 5.4, dated Jun 25, 2026. go dump some configs and slay the day 💅✨🦋🎀🌈

📦 where this page comes from