Merge pull request #4481 from pataquets/add-shellescape-notice-to-exclaim-docs

Docs: add notice about `shellescape` usage in `exclaim` help.
This commit is contained in:
Oliver Blanthorn 2022-11-29 12:11:20 +01:00 committed by GitHub
commit 21c9f45a48
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -692,6 +692,8 @@ export async function nativeopen(...args: string[]) {
*
* Requires the native messenger, obviously.
*
* If you're using `exclaim` with arguments coming from a pipe, consider using [[shellescape]] to properly escape arguments and to prevent unsafe commands.
*
* If you want to use a different shell, just prepend your command with whatever the invocation is and keep in mind that most shells require quotes around the command to be executed, e.g. `:exclaim xonsh -c "1+2"`.
*
* Aliased to `!` but the exclamation mark **must be followed with a space**.