ros(1)

💅 ros(1) — hi bestie, welcome to Roswell

okay so first things first: this is the manual for ros(1), and the whole vibe is Roswell — Common Lisp environment setup Utility. yes that's the actual name, yes it's iconic, let's get into it ✨

---

🌸 SYNOPSIS

three ways to call her, pick your fighter:

ros [options] [command [args...]
ros [options] [--]script [args...]
ros [options] < script.ros

🦋 DESCRIPTION

Roswell is a command line tool for installing and managing Common Lisp implementations, and it's also a whole scripting infrastructure — for templating, writing, executing, compiling, distributing, downloading and installing ROSWELL-SCRIPTS written in Common Lisp. like it does both, she's multi-talented 💅

currently roswell supports sbcl, ccl, clisp and ecl as its supported lisp implementations. for further details see ros-install(1) — go read it, i'll wait 🫶

Scripts installed by roswell will be system wide if the appropriate directory is included in PATH. so like, check your PATH bestie, that's the whole secret.

---

🎀 SUBCOMMANDS

listed in an order of utility/frequency, so the baddies come first 😌

• install — Install a given implementation (e.g. sbcl, ccl) or a system (e.g. alexandria) for the roswell environment. See ros-install(1).
• init [name[.ros]] — Create a new ros script. .ros is optional, and is added automatically (yes, automatically, she's got you). See ros-init.
• dump [executable|output] [script] — Dump an image of the script for the faster startup or to make an executable. See ros-dump.
• build — Make an executable from the script. See ros-build.
• run — Initiate REPL. See ros-run.
• use — Change the default implementation used by roswell. See ros-use.
• list — List the various informations. See ros-list.
• config — Get and set the options. See ros-config.
• setup — Run the initial setup. See ros-setup.
• emacs — Launch emacs with slime. See ros-emacs.
• wait — Wait forever, used for daemonizing the script. See ros-wait.
• delete — Delete an installed implementation. See ros-delete.
• version — Show the roswell version information. See ros-version.
• help — Show the subcommand help.

---

✨ OPTIONS ✨

heads up: Options are processed in left-to-right order. order matters, don't come for her.

• -w CODE, --wrap CODE — Run the script with a shell wrapper CODE, e.g. rlwrap. she's wearing a little coat 🧥
• -m IMAGE, --image IMAGE — Continue from Lisp image IMAGE.
• -L NAME, --lisp NAME — Run the script with a lisp impl NAME[/VERSION] if present, e.g. sbcl-bin, sbcl/1.2.16. Fails otherwise. (that "otherwise" is doing real work, respect it)
• -l FILE, --load FILE — Load a lisp file FILE while building.
• -S X, --source-registry X — Override the source registry of asdf systems.
• -s SYSTEM, --system SYSTEM — Load the asdf SYSTEM while building.
• --load-system SYSTEM — Same as above (buildapp compatibility). twins fr fr
• -p PACKAGE, --package PACKAGE — Change the current package to PACKAGE.
• -sp SP, --system-package SP — Combination of -s SP and -p SP. two for one, we love a bundle 🎀
• -e FORM, --eval FORM — Evaluate FORM while building.
• --require MODULE — require MODULE while building.
• -q, --quit — quit lisp here. bye bestie 👋
• -r FUNC, --restart FUNC — the build image restarts from calling FUNC.
• -E FUNC, --entry FUNC — the build image restarts from calling (FUNC argv).
• -i FORM, --init FORM — evaluate FORM after the restart.
• -ip FORM, --print FORM — evaluate and princ FORM after the restart.
• -iw FORM, --write FORM — evaluate and write FORM after the restart.
• -F FORM, --final FORM — evaluate FORM before dumping the IMAGE.
• -R, --rc — try to read /etc/rosrc, ~/.roswell/init.lisp.
• +R, --no-rc — skip /etc/rosrc, ~/.roswell/init.lisp. (yes, plus sign, she's quirky like that)
• -Q, --quicklisp — load quicklisp (default).
• +Q, --no-quicklisp — do not load quicklisp.
• -v, --verbose — be quite verbose while building. she will tell you everything 💀
• --quiet — suppress output while building (default).
• --test — for test purpose.
• dynamic-space-size=[size in MB] — SBCL specific. The argument is passed to SBCL by --dynamic-space-size.

---

🌈 ENVIRONMENTAL VARIABLES

• ROSWELL_HOME — Specifies the home directory of roswell, defaulted to $HOME on Unix platform. that's where she lives 🏠

---

💀 BUGS

Check out issues list (https://github.com/roswell/roswell/issues). not me sending you straight to the issue tracker but like, that's where the lore is 🔥

---

🫶 SEE ALSO

sbcl(1) ros-dump(1) ros-init(1) ros-install(1) ros-list(1) ros-setup(1)

---

👑 AUTHORS

Roswell Project Team.

---

and that's the whole page, bestie — you made it to the end 🎉 this was ros(1), brought to you by the Roswell Project Team, and if you ever get lost just remember: ros help has your back 💖✨