[BEEEP] SM-1005 - Add env output option

[tangowithfoxtrot]

Type of change

• Bug fix
• New feature development
• Tech debt (refactoring, code cleanup, dependency upgrades, etc)
• Build/deploy pipeline (DevOps)
• Other

Objective

Add an env output option to bws. This allows for easier command-line usage in scripts, particularly where a JSON or YAML parser is not desirable or available.

Basic usage examples in Bash:

• source <(bws secret get ec9e0489-244e-4b3f-8782-b0a800fe562f -o env)
• bws secret list -o env > .env

Code changes

• crates/bws/src/render.rs: Output secrets in key="value" format

Screenshots

Before you submit

• Please add unit tests where it makes sense to do so (encouraged but not required)

[bitwarden-bot]

Checkmarx One – Scan Summary & Details – 8edd38c1-e153-4dcd-b299-b2caeeead124

No New Or Fixed Issues Found

[dani-garcia]

Nice! A couple of small things:

• Not sure how this is usually done by other clients but we may need to escape characters in the key and the value, at the moment you can create a key like 'key="still the key" which is probably going to cause issues.
• Should we add the note at the end of the line as a comment? something like key="value" # note? Not sure if that's supported correctly in all the env parsers though, and we probably need to remove newlines so maybe it's not worth it.
• I think you can use the pretty_print function to get colored output, using sh or bash as a language.

[tangowithfoxtrot]

Not sure how this is usually done by other clients but we may need to escape characters in the key and the value, at the moment you can create a key like 'key="still the key" which is probably going to cause issues.

Good point. I hadn't considered that... I'll try to work something out for the escape characters.

Should we add the note at the end of the line as a comment? something like key="value" # note? Not sure if that's supported correctly in all the env parsers though, and we probably need to remove newlines so maybe it's not worth it.

I actually had a version of this in my own fork of the CLI, where I didn't have any issues, but I think in the scripts that I wrote that relied on it stripped-out the comments. I'd be fine excluding the notes to avoid dealing with any potential parsing issues that could occur.

I think you can use the pretty_print function to get colored output, using sh or bash as a language.

Very nice! I'll switch to using that!

[tangowithfoxtrot]

@dani-garcia, regarding problematic key names: what do you think of commenting the key-value pair out if it's non-POSIX-compliant? Like this:

[dani-garcia]

That seems reasonable to me, the comment explaining why they are excluded is a great touch!

[dani-garcia]

Nice, thank you!