BST-SHELL(1)

✨ bst-shell — the shell-into-a-sandbox page, bestie edition ✨

okay so welcome to the bst shell manual, literally the manual for the bst shell command 💅 buckle up because we're getting you into an element's sandbox and it's giving main character energy 🦋

---

🌸 NAME 🌸

bst-shell — shell into an element's sandbox environment 🐚✨

---

🎀 SYNOPSIS 🎀

bst shell [OPTIONS] [TARGET] [COMMAND]...

that's it, that's the whole vibe. periodt.

---

💖 DESCRIPTION 💖

Run a command in the target element's sandbox environment. no cap, that's the whole job.

When this command is executed from a workspace directory, the default is to shell into the workspace element. like, it just knows. iykyk 🧚

This will stage a temporary sysroot for running the target element, assuming it has already been built and all required artifacts are in the local cache. so fr fr, make sure it's built first or you're gonna be sitting there like 😭

Use -- to separate a command from the options to bst, otherwise bst may respond to them instead. this is THE rule, bestie, do not skip it. e.g.

bst shell example.bst -- df -h

Use the --build option to create a temporary sysroot for building the element instead. two moods: running mood and building mood 💜

If no COMMAND is specified, the default is to attempt to run an interactive shell. yes queen, you just get dropped into a shell, iconic 👑

---

✨ OPTIONS ✨

• -b, --build — Stage dependencies and sources to build. it's the building era 🏗️
• --mount HOSTPATH PATH — Mount a file or directory into the sandbox. bring your stuff with you 🎒
• --isolate — Create an isolated build sandbox. alone time, but make it builds 🦋
• -t, --use-buildtree — Stage a buildtree. Will fail if a buildtree is not available. pull-buildtrees configuration is needed if the buildtree is not available locally. so like, if it's not there locally you gotta have that config or it's just not happening 🙈
• --artifact-remote REMOTE — A remote for uploading and downloading artifacts. artifacts need a home too 🏠
• --source-remote REMOTE — A remote for uploading and downloading cached sources. sources, but make it remote 📦
• --ignore-project-artifact-remotes — Ignore remote artifact cache servers recommended by projects. not me ignoring the project's suggestions 💀
• --ignore-project-source-remotes — Ignore remote source cache servers recommended by projects. same energy, but for sources 🌈

---

heads up bestie: that -- thing in the description? it's not decorative. if you don't use it, bst might eat your command's options and you'll be so confused. protect your flags 🫶

---

and that's the whole page!! this was bst shell from the bst shell manual, version 2.5, dated 2025-05-09 💖 thanks for reading, go stage that sysroot, slay, and remember: no cap, use the -- 🌟