Sixel

0.7.0

en-US/Sixel.dll-Help.xml

<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" schema="maml" xmlns="http://msh">
  <command:command>
    <command:details>
      <command:name>ConvertTo-Sixel</command:name>
      <maml:description>
        <maml:para>Converts an image to Sixel, Kitty, InlineImage or Blocks.
To display in the console</maml:para>
      </maml:description>
      <command:verb>ConvertTo</command:verb>
      <command:noun>Sixel</command:noun>
    </command:details>
    <maml:description>
      <maml:para>The `ConvertTo-Sixel` converts an image to display in the console.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>ConvertTo-Sixel</maml:name>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>Force</maml:name>
          <maml:description>
            <maml:para>Force the command to attempt to output sixel data even if the terminal does not support sixel.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>Height</maml:name>
          <maml:description>
            <maml:para>Height of the image in character cells, the width will be scaled to maintain aspect ratio.
if both Width and Height are given then it will clamp to the smaller.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">int</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>MaxColors</maml:name>
          <maml:description>
            <maml:para>The maximum number of colors to use in a sixel image.
Max is 256 colors.
(only applicable to sixel protocol)</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">int</command:parameterValue>
        </command:parameter>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none">
          <maml:name>Path</maml:name>
          <maml:description>
            <maml:para>A path to a local image.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="true">String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>Protocol</maml:name>
          <maml:description>
            <maml:para>Select the image protocol to output.
Supports Sixel, InlineImageProtocol, KittyGraphicsProtocol, Block</maml:para>
            <maml:para>It will attempt to autoselect the supported image protocol for your terminal.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">ImageProtocol</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>Width</maml:name>
          <maml:description>
            <maml:para>Width of the image in character cells, the height will be scaled to maintain aspect ratio.</maml:para>
            <maml:para>if both Width and Height are given then it will clamp to the smaller.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">int</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
      <command:syntaxItem>
        <maml:name>ConvertTo-Sixel</maml:name>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>Force</maml:name>
          <maml:description>
            <maml:para>Force the command to attempt to output sixel data even if the terminal does not support sixel.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>Height</maml:name>
          <maml:description>
            <maml:para>Height of the image in character cells, the width will be scaled to maintain aspect ratio.
if both Width and Height are given then it will clamp to the smaller.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">int</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>MaxColors</maml:name>
          <maml:description>
            <maml:para>The maximum number of colors to use in a sixel image.
Max is 256 colors.
(only applicable to sixel protocol)</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">int</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>Protocol</maml:name>
          <maml:description>
            <maml:para>Select the image protocol to output.
Supports Sixel, InlineImageProtocol, KittyGraphicsProtocol, Block</maml:para>
            <maml:para>It will attempt to autoselect the supported image protocol for your terminal.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">ImageProtocol</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>Timeout</maml:name>
          <maml:description>
            <maml:para>Timeout for webrequest</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">TimeSpan</command:parameterValue>
        </command:parameter>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>Url</maml:name>
          <maml:description>
            <maml:para>A URL of the image.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="true">Uri</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>Width</maml:name>
          <maml:description>
            <maml:para>Width of the image in character cells, the height will be scaled to maintain aspect ratio.</maml:para>
            <maml:para>if both Width and Height are given then it will clamp to the smaller.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">int</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
      <command:syntaxItem>
        <maml:name>ConvertTo-Sixel</maml:name>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>Force</maml:name>
          <maml:description>
            <maml:para>Force the command to attempt to output sixel data even if the terminal does not support sixel.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>Height</maml:name>
          <maml:description>
            <maml:para>Height of the image in character cells, the width will be scaled to maintain aspect ratio.
if both Width and Height are given then it will clamp to the smaller.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">int</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>MaxColors</maml:name>
          <maml:description>
            <maml:para>The maximum number of colors to use in a sixel image.
Max is 256 colors.
(only applicable to sixel protocol)</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">int</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>Protocol</maml:name>
          <maml:description>
            <maml:para>Select the image protocol to output.
Supports Sixel, InlineImageProtocol, KittyGraphicsProtocol, Block</maml:para>
            <maml:para>It will attempt to autoselect the supported image protocol for your terminal.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">ImageProtocol</command:parameterValue>
        </command:parameter>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>Stream</maml:name>
          <maml:description>
            <maml:para>A stream of an image.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="true">Stream</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>Width</maml:name>
          <maml:description>
            <maml:para>Width of the image in character cells, the height will be scaled to maintain aspect ratio.</maml:para>
            <maml:para>if both Width and Height are given then it will clamp to the smaller.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">int</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
      <command:syntaxItem>
        <maml:name>ConvertTo-Sixel</maml:name>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>Force</maml:name>
          <maml:description>
            <maml:para>Force the command to attempt to output sixel data even if the terminal does not support sixel.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>Height</maml:name>
          <maml:description>
            <maml:para>Height of the image in character cells, the width will be scaled to maintain aspect ratio.
if both Width and Height are given then it will clamp to the smaller.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">int</command:parameterValue>
        </command:parameter>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>InputObject</maml:name>
          <maml:description>
            <maml:para>InputObject from Pipeline, can be filepath or base64 encoded string of an image.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="true">String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>MaxColors</maml:name>
          <maml:description>
            <maml:para>The maximum number of colors to use in a sixel image.
Max is 256 colors.
(only applicable to sixel protocol)</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">int</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>Protocol</maml:name>
          <maml:description>
            <maml:para>Select the image protocol to output.
Supports Sixel, InlineImageProtocol, KittyGraphicsProtocol, Block</maml:para>
            <maml:para>It will attempt to autoselect the supported image protocol for your terminal.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">ImageProtocol</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>Width</maml:name>
          <maml:description>
            <maml:para>Width of the image in character cells, the height will be scaled to maintain aspect ratio.</maml:para>
            <maml:para>if both Width and Height are given then it will clamp to the smaller.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">int</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
        <maml:name>Force</maml:name>
        <maml:description>
          <maml:para>Force the command to attempt to output sixel data even if the terminal does not support sixel.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
        <maml:name>Height</maml:name>
        <maml:description>
          <maml:para>Height of the image in character cells, the width will be scaled to maintain aspect ratio.
if both Width and Height are given then it will clamp to the smaller.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="true">int</command:parameterValue>
      </command:parameter>
      <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
        <maml:name>InputObject</maml:name>
        <maml:description>
          <maml:para>InputObject from Pipeline, can be filepath or base64 encoded string of an image.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="true">String</command:parameterValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
        <maml:name>MaxColors</maml:name>
        <maml:description>
          <maml:para>The maximum number of colors to use in a sixel image.
Max is 256 colors.
(only applicable to sixel protocol)</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="true">int</command:parameterValue>
      </command:parameter>
      <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none">
        <maml:name>Path</maml:name>
        <maml:description>
          <maml:para>A path to a local image.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="true">String</command:parameterValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
        <maml:name>Protocol</maml:name>
        <maml:description>
          <maml:para>Select the image protocol to output.
Supports Sixel, InlineImageProtocol, KittyGraphicsProtocol, Block</maml:para>
          <maml:para>It will attempt to autoselect the supported image protocol for your terminal.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="true">ImageProtocol</command:parameterValue>
      </command:parameter>
      <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
        <maml:name>Stream</maml:name>
        <maml:description>
          <maml:para>A stream of an image.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="true">Stream</command:parameterValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
        <maml:name>Timeout</maml:name>
        <maml:description>
          <maml:para>Timeout for webrequest</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="true">TimeSpan</command:parameterValue>
      </command:parameter>
      <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
        <maml:name>Url</maml:name>
        <maml:description>
          <maml:para>A URL of the image.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="true">Uri</command:parameterValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
        <maml:name>Width</maml:name>
        <maml:description>
          <maml:para>Width of the image in character cells, the height will be scaled to maintain aspect ratio.</maml:para>
          <maml:para>if both Width and Height are given then it will clamp to the smaller.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="true">int</command:parameterValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <dev:name>System.String</dev:name>
        </dev:type>
        <maml:description>
          <maml:para>Path, url, Base64 String, Stream of an image file</maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <dev:name>System.String</dev:name>
        </dev:type>
        <maml:description>
          <maml:para>A sixel string</maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <maml:alertSet>
      <maml:alert>
        <maml:para>This will only work if your terminal supports sixel images.</maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>--------- -------------------------- EXAMPLE 1 -------------------------- ---------</maml:title>
        <maml:introduction>
          <maml:para>```powershell
PS C:\&gt; ConvertTo-Sixel -Url 'https://imgs.xkcd.com/comics/git_commit.png'
```</maml:para>
          <maml:para>&#x80;</maml:para>
          <maml:para>Converts the xkcd.</maml:para>
        </maml:introduction>
        <dev:code />
        <dev:remarks />
      </command:example>
      <command:example>
        <maml:title>--------- -------------------------- EXAMPLE 2 -------------------------- ---------</maml:title>
        <maml:introduction>
          <maml:para>```powershell
PS C:\&gt; ConvertTo-Sixel -Path C:\files\smiley.png
```</maml:para>
          <maml:para>&#x80;</maml:para>
          <maml:para>Converts a local file.</maml:para>
        </maml:introduction>
        <dev:code />
        <dev:remarks />
      </command:example>
    </command:examples>
    <command:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>Online Version</maml:linkText>
        <command:uri>https://github.com/trackd/Sixel/blob/main/docs/en-US/ConvertTo-Sixel.md</command:uri>
      </maml:navigationLink>
    </command:relatedLinks>
  </command:command>
  <command:command>
    <command:details>
      <command:name>ConvertTo-SixelGif</command:name>
      <maml:description>
        <maml:para>Converts a gif to a sixel animation.
 
this cmdlet only supports Sixel.</maml:para>
      </maml:description>
      <command:verb>ConvertTo</command:verb>
      <command:noun>SixelGif</command:noun>
    </command:details>
    <maml:description>
      <maml:para>The `ConvertTo-SixelGif` takes a gif and converts it to sixel animation</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>ConvertTo-SixelGif</maml:name>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>Force</maml:name>
          <maml:description>
            <maml:para>Force the command to attempt to output sixel data even if the terminal does not support sixel.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>LoopCount</maml:name>
          <maml:description>
            <maml:para>The amount of times the gif will loop.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">int</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>MaxColors</maml:name>
          <maml:description>
            <maml:para>The maximum number of colors to use in the image.
Max is 256.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">int</command:parameterValue>
        </command:parameter>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none">
          <maml:name>Path</maml:name>
          <maml:description>
            <maml:para>A path to a local gif to convert to sixel.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="true">String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>Width</maml:name>
          <maml:description>
            <maml:para>Width of the image in character cells, the height will be scaled to maintain aspect ratio.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">int</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
      <command:syntaxItem>
        <maml:name>ConvertTo-SixelGif</maml:name>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>Force</maml:name>
          <maml:description>
            <maml:para>Force the command to attempt to output sixel data even if the terminal does not support sixel.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>LoopCount</maml:name>
          <maml:description>
            <maml:para>The amount of times the gif will loop.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">int</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>MaxColors</maml:name>
          <maml:description>
            <maml:para>The maximum number of colors to use in the image.
Max is 256.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">int</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>Timeout</maml:name>
          <maml:description>
            <maml:para>Timeout for webrequest</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">TimeSpan</command:parameterValue>
        </command:parameter>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>Url</maml:name>
          <maml:description>
            <maml:para>A URL of the gif to download and convert to sixel.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="true">Uri</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>Width</maml:name>
          <maml:description>
            <maml:para>Width of the image in character cells, the height will be scaled to maintain aspect ratio.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">int</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
      <command:syntaxItem>
        <maml:name>ConvertTo-SixelGif</maml:name>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>Force</maml:name>
          <maml:description>
            <maml:para>Force the command to attempt to output sixel data even if the terminal does not support sixel.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>LoopCount</maml:name>
          <maml:description>
            <maml:para>The amount of times the gif will loop.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">int</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>MaxColors</maml:name>
          <maml:description>
            <maml:para>The maximum number of colors to use in the image.
Max is 256.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">int</command:parameterValue>
        </command:parameter>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>Stream</maml:name>
          <maml:description>
            <maml:para>A stream of an image.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="true">Stream</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>Width</maml:name>
          <maml:description>
            <maml:para>Width of the image in character cells, the height will be scaled to maintain aspect ratio.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">int</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
      <command:syntaxItem>
        <maml:name>ConvertTo-SixelGif</maml:name>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>Force</maml:name>
          <maml:description>
            <maml:para>Force the command to attempt to output sixel data even if the terminal does not support sixel.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>LoopCount</maml:name>
          <maml:description>
            <maml:para>The amount of times the gif will loop.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">int</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>MaxColors</maml:name>
          <maml:description>
            <maml:para>The maximum number of colors to use in the image.
Max is 256.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">int</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>Width</maml:name>
          <maml:description>
            <maml:para>Width of the image in character cells, the height will be scaled to maintain aspect ratio.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">int</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
        <maml:name>Force</maml:name>
        <maml:description>
          <maml:para>Force the command to attempt to output sixel data even if the terminal does not support sixel.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
        <maml:name>LoopCount</maml:name>
        <maml:description>
          <maml:para>The amount of times the gif will loop.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="true">int</command:parameterValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
        <maml:name>MaxColors</maml:name>
        <maml:description>
          <maml:para>The maximum number of colors to use in the image.
Max is 256.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="true">int</command:parameterValue>
      </command:parameter>
      <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none">
        <maml:name>Path</maml:name>
        <maml:description>
          <maml:para>A path to a local gif to convert to sixel.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="true">String</command:parameterValue>
      </command:parameter>
      <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
        <maml:name>Stream</maml:name>
        <maml:description>
          <maml:para>A stream of an image.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="true">Stream</command:parameterValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
        <maml:name>Timeout</maml:name>
        <maml:description>
          <maml:para>Timeout for webrequest</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="true">TimeSpan</command:parameterValue>
      </command:parameter>
      <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
        <maml:name>Url</maml:name>
        <maml:description>
          <maml:para>A URL of the gif to download and convert to sixel.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="true">Uri</command:parameterValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
        <maml:name>Width</maml:name>
        <maml:description>
          <maml:para>Width of the image in character cells, the height will be scaled to maintain aspect ratio.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="true">int</command:parameterValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <dev:name>System.String</dev:name>
        </dev:type>
        <maml:description>
          <maml:para>Path or url to an gif file</maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <dev:name>System.String</dev:name>
        </dev:type>
        <maml:description>
          <maml:para>a sixel animation</maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <maml:alertSet>
      <maml:alert>
        <maml:para>This will only work if your terminal supports sixel images.
Windows Terminal version 1.22 or newer</maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>--------- -------------------------- EXAMPLE 1 -------------------------- ---------</maml:title>
        <maml:introduction>
          <maml:para>```powershell
PS C:\&gt; ConvertTo-SixelGif -Url 'https://i.gifer.com/10j2.gif'
```</maml:para>
        </maml:introduction>
        <dev:code />
        <dev:remarks />
      </command:example>
      <command:example>
        <maml:title>--------- -------------------------- EXAMPLE 2 -------------------------- ---------</maml:title>
        <maml:introduction>
          <maml:para>```powershell
PS C:\&gt; ConvertTo-SixelGif -Path $env:USERPROFILE\desktop\hello.gif
```</maml:para>
          <maml:para>&#x80;</maml:para>
          <maml:para>Converts a local file to sixel format</maml:para>
        </maml:introduction>
        <dev:code />
        <dev:remarks />
      </command:example>
    </command:examples>
    <command:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>Online Version</maml:linkText>
        <command:uri>https://github.com/trackd/Sixel/blob/main/docs/en-US/ConvertTo-SixelGif.md</command:uri>
      </maml:navigationLink>
    </command:relatedLinks>
  </command:command>
</helpItems>