Need documentation when using ! in an environment variable value

[macdonst]

When you run the command:

begin env create -e staging -n API_KEY -v fake!key
# or
begin env create -e staging -n API_KEY -v "fake!key"

The command fails to execute. Which is not surprising since the ! needs to be escaped like:

begin env create -e staging -n API_KEY -v "fake\!key"

but this is not immediately apparent to users. The situation is even worse on Windows (PowerShell) where the command:

begin env create -e staging -n API_KEY -v fake!key

sets and API_KEY to the value fake.

Expected behaviour

We should update our documentation to add the double quotes around environment variable values and show an example of an escaped value.

Steps to reproduce

Run the command:

begin env create -e staging -n 1API_KEY -v fake!key

Platform version

• MacOS 14.2.1
• Begin version: main-21f0079
• Node.js v18.15.0

Also reported by a user at our workshop on Windows. I will attempt to reproduce when I get to a Windows machine.