Quoting and escaping shell script arguments

The recommended environment ("parent shell") for running detect12.sh on Linux is Bash, and Bash or Zsh on Mac.

When an argument contains a space or other non double quote special character, you can wrap the argument in single quotes, or escape the special character with a backslash (\). The quotes can surround either the value or the entire argument.

For example:

# name: Project Test
bash <(curl -s -L https://detect.blackduck.com/detect12.sh) --detect.project.name='Project Test'

# name: Project Test
bash <(curl -s -L https://detect.blackduck.com/detect12.sh) --detect.project.name=Project\ Test

# name: Project!Test
bash <(curl -s -L https://detect.blackduck.com/detect12.sh) --detect.project.name=Project\!Test

You can include a double quote by single quoting the string, and escaping the double quotes with backslashes:

# license: BSD 3-clause "New" or "Revised" License
bash <(curl -s -L https://detect.blackduck.com/detect12.sh) --detect.project.version.license='BSD 3-clause \"New\" or \"Revised\" License' 

On Windows, you can run detect12.ps1 in either a Windows Command Prompt session, or a PowerShell session. This section describes running detect12.ps1 in a Windows Command Prompt session.

When an argument contains a space or other non quote special character, you can wrap the argument in single quotes, or escape the special character with a backtick (`). The quotes can surround either the value or the entire argument.

For example:

# name: Project Test
powershell "[Net.ServicePointManager]::SecurityProtocol = 'tls12'; irm https://detect.blackduck.com/detect12.ps1?$(Get-Random) | iex; detect" --detect.project.name='Project Test'

# name: Project Test
powershell "[Net.ServicePointManager]::SecurityProtocol = 'tls12'; irm https://detect.blackduck.com/detect12.ps1?$(Get-Random) | iex; detect" '--detect.project.name=Project Test'

# name: Project Test
powershell "[Net.ServicePointManager]::SecurityProtocol = 'tls12'; irm https://detect.blackduck.com/detect12.ps1?$(Get-Random) | iex; detect" --detect.project.name=Project` Test

When an argument contains a comma, you can wrap the argument in single quotes, and escape the special character with a backtick (`). In the case of a name with a comma and a space, you would use a backtick in front of both the comma and space.

For example:

# name: Project,Test   
Powershell "[Net.ServicePointManager]::SecurityProtocol = 'tls12'; irm  https://detect.blackduck.com/detect12.ps1?$(Get-Random) | iex; detect --blackduck.url=<url> --detect.project.name='Project,Test'"   

# name: Project,Test   
Powershell "[Net.ServicePointManager]::SecurityProtocol = 'tls12'; irm  https://detect.blackduck.com/detect12.ps1?$(Get-Random) | iex; detect --blackduck.url=<url> '--detect.project.name=Project,Test'"   

# name: Project, Test   
Powershell "[Net.ServicePointManager]::SecurityProtocol = 'tls12'; irm  https://detect.blackduck.com/detect12.ps1?$(Get-Random) | iex; detect --blackduck.url=<url> --detect.project.name=Project`,` Test"   

You can include a single quote by doubling it:

# name: singlequote'
powershell "[Net.ServicePointManager]::SecurityProtocol = 'tls12'; irm https://detect.blackduck.com/detect12.ps1?$(Get-Random) | iex; detect" --detect.project.name='singlequote'''

You can include a double quote using this sequence: double quote, 2 backslashes, 2 double quotes:

# license: BSD 3-clause "New" or "Revised" License
powershell "[Net.ServicePointManager]::SecurityProtocol = 'tls12'; irm https://detect.blackduck.com/detect12.ps1?$(Get-Random) | iex; detect" --detect.project.version.license='BSD 3-clause "\\""New"\\"" or "\\""Revised"\\"" License'

An alternative environment for running detect12.ps1 on Windows is to run it from inside a PowerShell session.

This invocation has an important distinction from the Command Prompt invocation in that the script does NOT EXIT the session. This is desirable when running the script from a terminal session but not from within a CI/CD environment.

When an argument contains a space or other non-quote special character, you can wrap the argument in single quotes, or escape the special character with a backtick. The quotes can surround either the value or the entire argument.

For example:

# name: Project Test
[Net.ServicePointManager]::SecurityProtocol = 'tls12'; $Env:DETECT_EXIT_CODE_PASSTHRU=1; irm https://detect.blackduck.com/detect12.ps1?$(Get-Random) | iex; detect --detect.project.name='Project Test'

# name: Project Test
[Net.ServicePointManager]::SecurityProtocol = 'tls12'; $Env:DETECT_EXIT_CODE_PASSTHRU=1; irm https://detect.blackduck.com/detect12.ps1?$(Get-Random) | iex; detect "--detect.project.name=Project Test"

When an argument contains a comma, you must escape the special character with a backtick (`). In the case of a name with a comma and a space, you would use a backtick in front of both the comma and space.

For example:

# name: Project,Test
[Net.ServicePointManager]::SecurityProtocol = 'tls12'; $Env:DETECT_EXIT_CODE_PASSTHRU=1; irm https:/
/detect.blackduck.com/detect11.ps1?$(Get-Random) | iex; detect --detect.project.name=Project`,Test

# name: Project, Test
[Net.ServicePointManager]::SecurityProtocol = 'tls12'; $Env:DETECT_EXIT_CODE_PASSTHRU=1; irm https:/
/detect.blackduck.com/detect11.ps1?$(Get-Random) | iex; detect --detect.project.name=Project`,` Test

You can include a double quote using this sequence: backslash, backtick, double quote:

# license: BSD 3-clause "New" or "Revised" License
[Net.ServicePointManager]::SecurityProtocol = 'tls12'; $Env:DETECT_EXIT_CODE_PASSTHRU=1; irm https://detect.blackduck.com/detect12.ps1?$(Get-Random) | iex; detect --detect.project.version.license="BSD 3-clause \`"New\`" or \`"Revised\`" License"