github.com/lmorg/murex@v0.0.0-20240217211045-e081c89cd4ef/docs/commands/esccli.md (about)

     1  # `esccli`
     2  
     3  > Escapes an array so output is valid shell code
     4  
     5  ## Description
     6  
     7  `esccli` takes an array and escapes any characters that might cause problems
     8  when pasted back into the terminal. Typically you'd want to use this against
     9  command parameters.
    10  
    11  ## Usage
    12  
    13  ```
    14  <stdin> -> esccli -> <stdout>
    15  
    16  esccli @array -> <stdout>
    17  ```
    18  
    19  ## Examples
    20  
    21  As a method
    22  
    23  ```
    24  » alias foobar=out 'foo$b@r'
    25  » alias -> [foobar]
    26  [
    27      "out",
    28      "foo$b@r"
    29  ]
    30  » alias -> [foobar] -> esccli
    31  out foo\$b\@r
    32  ```
    33  
    34  As a function
    35  
    36  ```
    37  » alias -> [foobar] -> set fb
    38  » $fb
    39  ["out","foo$b@r"]
    40  » esccli @fb
    41  out foo\$b\@r
    42  ```
    43  
    44  ## See Also
    45  
    46  * [`[ Index ]`](../parser/item-index.md):
    47    Outputs an element from an array, map or table
    48  * [`alias`](../commands/alias.md):
    49    Create an alias for a command
    50  * [`escape`](../commands/escape.md):
    51    Escape or unescape input
    52  * [`eschtml`](../commands/eschtml.md):
    53    Encode or decodes text for HTML
    54  * [`escurl`](../commands/escurl.md):
    55    Encode or decodes text for the URL
    56  * [`out`](../commands/out.md):
    57    Print a string to the STDOUT with a trailing new line character
    58  
    59  <hr/>
    60  
    61  This document was generated from [builtins/core/escape/escape_doc.yaml](https://github.com/lmorg/murex/blob/master/builtins/core/escape/escape_doc.yaml).