forEach Command
The
foreach command will execute another command against every item in an incoming list. The list can be passed directly or piped into this command. The default delimiter is a new line so this works great piping the output of file listings directly in, which have a file name per line.This powerful construct allows you to perform basic loops from the CLI over arbitrary input.
Most of the examples show file listings, but any input can be used that you want to iterate over.
This example will use the echo command to output each filename returned by ls. The echo is called
once for every line of output being piped in.
1
ls --simple | forEach
Copied!
The default command is "echo" but you can perform an action against the incoming list of items.
This example will use "cat" to output the contents of each file in the incoming list.
1
ls *.json --simple | forEach cat
Copied!
You can customize the delimiter. This example passes a hard-coded input and spits it on commas.
So here, the
install command is run three times, once for each package. A contrived, but effective example.1
forEach input="coldbox,testbox,cborm" delimiter="," command=install
Copied!
If you want a more complex command, you can choose exactly where you wish to use the incoming item
by referencing the default system setting expansion of
${item}. Remember to escape the expansion in
your command so it's resolution is deferred until the forEach runs it internally.
Here we echo each file name followed by the contents of the file.1
ls *.json --simple | foreach "echo \${item} && cat \${item}"
Copied!
You may also choose a custom placeholder name for readability.
1
ll *.json --simple | foreach "echo \${filename} && cat \${filename}" filename
Copied!
Iterating over JSON
The
forEach can also iterate over JSON representations of objects or arrays. This means you can pipe in JSON from a file, a command such as package show or any REPL operation that returns complex data. The delimiter parameter is ignored for JSON input.1
package show dependencies | foreach
Copied!
If iterating over an array, each item in the array will be available as
${item}. If iterating over a object, the object keys will be in ${item} and the values will be in ${value}.1
package show dependencies | foreach "echo 'You have \${item} version \${value} installed'"
Copied!
You can customize the system setting name for value with the
valueName parameter to forEach.1
package show dependencies | foreach command="echo 'You have \${package} version \${version} installed'" itemName=package valueName=version
Copied!
Last modified 1mo ago
Copy link
Edit on GitHub
Contents
Iterating over JSON