Recipes
If you want 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.
Ingredients
Think of a recipe as a simple batch file for Windows or a shell script for Unix. It's just a text file where you place one command on each line and they are executed in order. Enter the commands exactly as you would from the interactive shell.
Technically a recipe can have any file extension, but the default recommendation is
.boxr which stands for "box recipe". Lines that start with a pound and whitespace characters (e.g. "# My Comments") will be ignored as comments. The pound character followed immediately by word-like characters is the mechanism for invoking CFML functions.buildSite.boxr
1
# Start with an empty folder
2
rm mySite --recurse --force
3
mkdir mySite
4
cd mySite
5
​
6
# Initialize this folder as a package
7
init name=mySite version=1.0.0 slug=mySlug
8
​
9
# Scaffold out a site and a handler
10
coldbox create app mySite
11
coldbox create handler myHandler index
12
​
13
# Add some required package
14
install coldbox
15
install cbmessagebox,cbstorages,cbvalidation
16
​
17
# Set the default port
18
package set defaultPort=8081
19
​
20
# Start up the embedded server
21
start
Copied!
Get Cooking
Execute your recipe with the
recipe command, giving it the path to the recipe file.1
recipe buildSite.boxr
Copied!
If any commands in the recipe stop and ask for input, the recipe will pause until you supply that input. All commands that have confirmations, etc should have a
--force flag for this purpose so you can run them headlessly without requiring your input. See the rm command above for an example.Spice It Up
You can also bind the recipe with arguments that will be replaced inside of your recipe at run time. Pass any arguments as additional parameters to the
recipe command and they will be passed along to the commands in your recipe.Named arguments
If you use named arguments to the recipe command, they will be accessible via environment variables inside the recipe as
${arg1Name}, ${arg2Name}, etc.Consider the following recipe:
notifyWinner.boxr
1
echo "Hello there, ${name}, You've won a ${prize}!"
Copied!
You would call it like so:
1
recipe recipeFile=notifyWinner.boxr name=Luis prize="NEW CAR"
Copied!
Output:
1
Hello there, Luis, You've won a NEW CAR!
Copied!
Note, all parameters to the
recipe command needed to be named, including the recipeFile.Positional Parameters
Now let's look at the same recipe set up to receive positional parameters.
1
echo "Hello there, ${1}\n You've won a ${2}!"
Copied!
You would call it like so:
1
recipe notifyWinner.boxr Luis "NEW CAR"
Copied!
Output:
1
Hello there, Luis, You've won a NEW CAR!
Copied!
Missing Args
If an argument is not passed, you can use the default value mechanism:
1
echo "Hello there, ${name:human}, You've won a ${prize:something cool}!"
Copied!
Is there an echo in here?
You can use
echo on and echo off in recipes to control whether the commands output to the console as they are executed. This can be useful for debugging or confirming the success of commands with no output. Echo is on by default.Note,
echo off doesn't suppress the output of the commands, just the printing of the command and its arguments prior to execution. This does not use the actual echo command and is a feature that only applies during the execution of recipes.1
# Now you see me
2
echo on
3
version
4
​
5
# Now you don't
6
echo off
7
version
Copied!
Output:
1
version
2
CommandBox 1.2.3.00000
3
echo off
4
CommandBox 1.2.3.00000
Copied!
Exiting a recipe
You can use the exit command in a recipe and instead of leaving the entire shell, the recipe will simply stop execution right there. If an exit code is passed, it will become the exit code of the recipe command as well as the entire shell.
1
exit 1
Copied!
Any command that errors or returns a non-0 exit code will end the recipe immediately and the recipe command will inherit that exit code. This line in a recipe will stop the recipe if there is not a
foobar property in your box.json, but not before outputting a message.1
package show foobar || echo "Missing property!" && exit 999
Copied!
On The Fly Commands
In addition to passing a file path to the
recipe command for execution, you can also pipe the contents of a file directly into the command. if the input does not match a file path, it is assumed to be executable commands.1
echo myCommands.txt | recipe
Copied!
This can also give you some interesting ability to do dynamic evaluation of command strings.
1
set cmd=version
2
echo ${cmd} | recipe
Copied!
Last modified 12d ago