Blog

Let’s get cooking with CommandBox Recipes!

Luis Majano February 13, 2015

Spread the word

Luis Majano

February 13, 2015

Spread the word


Share your thoughts

One exciting feature about CommandBox is the ability to group commands together into a lovingly little file we call, a recipe.  We even gave it its own extension, .boxr.  This little gem will allow you to automate several commands from your native shell, it will be faster to use our recipe command that allows you to run several CommandBox commands at once. This will allow you to only load the CommandBox engine once for all those commands, but still be dumped back at your native prompt when done. Recipes can also just be useful for a series of commands you run on a regular basis, from test executions, to compressing files, the possibilities are endless.  

Below is a simple example of how to create a recipe and execute it.  For further insight, we recommend you read our chapter on recipes in our CommandBox book.

How to start?

Recipes are modern batch files or shell scripts for those unix fans.It has the capability to execute commands just like if you are in the shell, have comments and even have the ability to do argument binding. Technically a recipe can have any file extension, but the default recommendation is .boxr which stands for "box recipe". Lines that start with a # will be ignored as comments. just like in many batch files.  Here is a nice example:


# Named param
echo "Hello $name, we are ready to start your recipe"
# Positional param
echo "Hello $1, we are ready to start your recipe"


# Start with an empty folder
rm mySite --recurse --force
mkdir mySite
cd mySite

# Initialize this folder as a package
init name=mySite version=1.0.0 slug=mySlug

# Scaffold out a site and a handler
coldbox create app mySite
coldbox create handler myHandler index

# Add some required package
install coldbox
install cbmessagebox,cbstorages,cbvaidation

# Set the default port
package set defaultPort=8081

# Start up the embedded server
start

 

Executing Your Recipe

You will use the recipe command in order to execute recipes.  You can find much more information about the recipe command by typing recipe help or visiting the API Docs.

recipe myrecipe.boxr

If you have named parameters you would execute it like this:

recipe recipeFile=myrecipe.boxr name=Luis

If you have positional parameters you would execute it like this:

recipe myrecipe.boxr Luis

As you can see, very nicely you can bind your recipes with dynamic content and automate pretty much anything.  We even have a contribution type in ForgeBox for all CommandBox recipes, so please share them with the world.

Add Your Comment

(2)

Dec 03, 2018 09:36:48 UTC

by Travis

Links on this post are broken.

Dec 03, 2018 16:00:06 UTC

by Brad Wood

Thanks, I've updated the links.

Recent Entries

One Language, Every Runtime: BoxLang Expands Beyond the Server

One Language, Every Runtime: BoxLang Expands Beyond the Server

Discover how BoxLang’s multi-runtime architecture helps developers build beyond the server with support for serverless functions, desktop applications, CI/CD workflows, Java integrations, containers, runtime management, and more.

Maria Jose Herrera
Maria Jose Herrera
June 04, 2026
MatchBox and WebAssembly: Running BoxLang in the Browser and at the Edge

MatchBox and WebAssembly: Running BoxLang in the Browser and at the Edge

The MatchBox open beta is live at https://boxlang.ortusbooks.com/boxlang-framework/matchbox, and it brings something genuinely new to the BoxLang ecosystem: a path into WebAssembly.

That means BoxLang code can now move into browser applications, static-site deployments, edge runtimes, and WASI-style containers - without requiring a JVM. The feature is still beta, but the core direction is already useful: write BoxLang, compile it with MatchBox, and ship the generated WASM artifact to wherever a small portable runtime makes sense.

Jacob Beers
Jacob Beers
June 04, 2026
BoxLang 1.14.0 : BoxSet is Here: BoxLang's New First-Class Set Type

BoxLang 1.14.0 : BoxSet is Here: BoxLang's New First-Class Set Type

BoxLang 1.14.0 ships something that JVM developers have wanted for a long time: a true first-class Set type baked directly into the language. Not a wrapper you reach for manually, not a createObject( "java", "java.util.HashSet" ) incantation you paste from a Stack Overflow answer years ago. A real BoxSet with literal syntax, operator overloads, a full functional pipeline, change listeners, JSON serialization, and deep Java interop.

Luis Majano
Luis Majano
June 03, 2026