github.com/lmorg/murex@v0.0.0-20240217211045-e081c89cd4ef/builtins/optional/encoders/base64_doc.yaml (about)

     1  - DocumentID: base64
     2    Title: >-
     3      `base64` 
     4    CategoryID: optional
     5    Summary: >-
     6      Encode or decode a base64 string
     7    Description: |-
     8      An optional builtin to encode or decode a base64 string.
     9    Usage: |-
    10      ```
    11      <stdin> -> base64 -> <stdout>
    12  
    13      <stdin> -> !base64 -> <stdout>
    14      ```
    15    Examples: |-
    16      Encode base64 string
    17  
    18      ```
    19      » out "Hello, World!" -> base64
    20      SGVsbG8sIFdvcmxkIQo=
    21      ```
    22  
    23      Decode base64 string
    24  
    25      ```
    26      » out "SGVsbG8sIFdvcmxkIQo=" -> !base64
    27      Hello, World!
    28      ```
    29    Detail: |-
    30      `base64` is very simplistic - particularly when compared to its GNU coreutil
    31      (for example) counterpart. If you want to use the `base64` binary on Linux
    32      or similar platforms then you will need to launch with the `exec` builtin:
    33  
    34      ```
    35      » out "Hello, World!" -> exec base64
    36      SGVsbG8sIFdvcmxkIQo=
    37      
    38      » out "SGVsbG8sIFdvcmxkIQo=" -> exec base64 -d
    39      Hello, World!
    40      ```
    41  
    42      However for simple tasks this builtin will out perform external tools because
    43      it doesn't require the OS fork processes.
    44    Synonyms:
    45    - base64
    46    - "!base64"
    47    Related:
    48    - bz2
    49    - gz
    50    - escape
    51    - eschtml
    52    - escurl
    53    - esccli