doctl --user-data help syntax wrong

[igpit]

Describe the Issue:
wrong help/usage for --user-data

running

doctl compute droplet create --help

shows the usage example:

doctl compute droplet create example-droplet --size s-2vcpu-2gb --image ubuntu-20-04-x64 --region nyc1 --user-data $'#!/bin/bash\n touch /root/example.txt; sudo apt update;sudo snap install doctl'

but at least running this from powershell in windows, this will create a user-data.txt with uninterpreted content, thus it will not run.

Environment:

• doctl version: latest, 1.106
• OS: windows powershell 5 or 7

Additional Details:

Needed fix

This is the correct syntax:

• use "`n" instead of "\n"
• do not prefix with $

Example:
--user-data "#!/bin/bash`n touch /root/example.txt; sudo apt update;sudo snap install doctl"

[danaelhe]

Hi there,

Thanks for bringing this to our attention, and for providing the correct syntax for Window powershell users. I will create a PR now that will explicitly call this out in our help documentation to avoid confusion in the future.

Thanks again!