REPL
CommandBox contains a
REPL command which is a powerful tool to execute ad-hoc CFML code from the command line. A REPL reads user input, evaluates it, prints the result, and then repeats the process. The CommandBox REPL supports the inline execution of both CF script or tags.1
CFSCRIPT-REPL: 5+5
2
=> 10
Copied!
Script REPL
The default mode of the
REPL command is to accept script. You can enter most any CF Script into the prompt for execution. If the script is an expression that returns a value, or sets a variable, that value/variable will be output. Variables that you set will be available to you until you exit the REPL command.1
CFSCRIPT-REPL: breakfast = ['bacon','eggs']
2
=> [
3
"bacon",
4
"eggs"
5
]
6
CFSCRIPT-REPL: breakfast.len()
7
=> 2
8
CFSCRIPT-REPL: breakfast.append( 'orange juice' )
9
=> [
10
"bacon",
11
"eggs",
12
"orange juice"
13
]
Copied!
Multi-line
Multi-line statements are also allowed. If you have typed a starting
{ without an ending }, the REPL will keep accepting lines until it has determined the statement to be finished. The prompt changes to ... until the statement is finished.1
CFSCRIPT-REPL: for( item in breakfast ) {
2
...echo( item & chr(10) )
3
...}
4
=> bacon
5
eggs
6
orange juice
Copied!
If you would like to abort a multi-line statement, simply type
exit at the prompt.Tag REPL
You can also enter tags at the REPL. Switch to this mode by setting the
script flag to false.1
REPL --!script
Copied!
Any output from the tags will be returned to the console.
1
CFML-REPL: plain text
2
=> plain text
3
CFML-REPL: <cfset name = "Brad Wood">
4
=>
5
CFML-REPL: <cfoutput>#reverse( name )#</cfoutput>
6
=> dooW darB
7
CFML-REPL: <cfif 1 eq 2>yes<cfelse>no</cfif>
8
=> no
Copied!
Multi-line statements are not currently supported in the tag REPL.
History
The script and tag REPL have their only history. Use the
up and down arrows to access previous things you typed. Your REPL history can be viewed and managed by the history command (once you exit the REPL).1
history type=scriptrepl
2
history type=tagrepl --clear
Copied!
Tab completion is currently not supported in either of the REPLs.
Environment Variable Expansions
You can use environment variable expansions in the REPL with the same syntax that works in the CLI and JSON files. Consider this example which sets an environment variable in the shell and then enters the REPL command and references the variable. Note, the variable is expanded in-place, so you still need to wrap it in quotes so the resulting CFML code is valid.
1
CommandBox> set foo=bar
2
CommandBox> REPL
3
​
4
CFSCRIPT-REPL: echo( '${foo}' )
5
bar
Copied!
Escapes work the same way in the REPL
1
CFSCRIPT-REPL: echo( '\${foo}' )
2
${foo}
Copied!
Last modified 1mo ago
Copy link
Edit on GitHub