BST(1)

💅 BST(1) — the bst manual, bestie edition 💅

okay so you found the manual for bst, and it lives in the bst Manual — welcome to the group chat, pull up a chair, we're building stuff 🎀

---

✨ NAME ✨

bst — build and manipulate BuildStream projects. that's it, that's the whole vibe. it's giving "one command to rule your whole pipeline" 👑

---

🌸 SYNOPSIS 🌸

bst [OPTIONS] COMMAND [ARGS]...

like, options first, then the command you actually wanna run, then whatever args that command wants. simple as 🦋

---

💖 DESCRIPTION 💖

Build and manipulate BuildStream projects. that's the whole thing, no notes 💅

Most of the main options override options in the user preferences configuration file.

so real talk: if you set something in your user preferences config file and then pass the same thing on the command line, the command line wins. the CLI is the main character here, no cap 😌

---

🌈 OPTIONS 🌈

• --version — show the version. quick lil "who am i" moment 💫
• -c, --config FILE — the configuration file to use. tell it where your config lives 📁
• -C, --directory DIRECTORY — project directory. default is the current directory, so if you're already standing in the right place you don't gotta say anything 🏠
• --on-error [continue|quit|terminate] — what to do when an error is encountered. pick your chaos level: continue, quit, or terminate 😭
• --fetchers INTEGER — maximum simultaneous download tasks. how many downloads can go at once 🫶
• --builders INTEGER — maximum simultaneous build tasks. how many builds can go at once 🔥
• --pushers INTEGER — maximum simultaneous upload tasks. how many uploads can go at once ☁️
• --max-jobs INTEGER — number of parallel jobs allowed for a given build task. parallelism per task, periodt ⚡
• --network-retries INTEGER — maximum retries for network tasks. because the wifi WILL betray you 🙈
• --no-interactive — force non interactive mode. otherwise this is automatically decided, so it'll figure itself out on its own usually ✨
• --verbose / --no-verbose — be extra verbose. yap mode: on or off 🗣️
• --debug / --no-debug — print debugging output. for when you need the tea ☕
• --error-lines INTEGER — maximum number of lines to show from a task log 📜
• --message-lines INTEGER — maximum number of lines to show in a detailed message 💬
• --log-file FILENAME — a file to store the main log. this allows storing the main log while in interactive mode, which is honestly so clutch 🧚
• --colors / --no-colors — force enable/disable ANSI color codes in output. aesthetic control, we love to see it 🎨
• --strict / --no-strict — elements must be rebuilt when their dependencies have changed. strict mode said "no shortcuts bestie" 💀
• -o, --option OPTION VALUE — specify a project option. takes an OPTION and a VALUE 🎯
• --default-mirror TEXT — the mirror to fetch from first, before attempting other mirrors. first choice, no hesitation 🪞
• --pull-buildtrees — include an element's build tree when pulling remote element artifacts 🌳
• --cache-buildtrees [always|auto|never] — cache artifact build tree content on creation. pick always, auto, or never 🗂️

---

👑 COMMANDS 👑

• help — print usage information. see bst-help(1) for full documentation on the help command. the "help me help you" command 🆘
• init — initialize a new BuildStream project. see bst-init(1) for full documentation on the init command. baby's first project 🍼
• build — build elements in a pipeline. see bst-build(1) for full documentation on the build command. the main event 🔨
• show — show elements in the pipeline. see bst-show(1) for full documentation on the show command. peek behind the curtain 👀
• shell — shell into an element's sandbox environment. see bst-shell(1) for full documentation on the shell command. get in there 🐚
• source — manipulate sources for an element. see bst-source(1) for full documentation on the source command. sources get their own command, iconic 📦
• workspace — manipulate developer workspaces. see bst-workspace(1) for full documentation on the workspace command. your lil dev corner 🛋️
• artifact — manipulate cached artifacts. see bst-artifact(1) for full documentation on the artifact command. yes it ends in a period in the original, we respect that 💅

---

bst Manual · version 2.5 · dated 2025-05-09

that's the whole page bestie, go build something gorgeous 💖✨🦋🌸🫶