.github/images/usage.svg

<!-- Generated by EK|SVAROG 0.1.1 -->
<svg width="830" height="952" viewBox="0 0 830 952" fill="none" xmlns="http://www.w3.org/2000/svg">

  <title>Artefactor Usage</title>

  <defs>
    <linearGradient id="fog" x1="0" x2="1" y1="0" y2="0">
      <stop offset="0%" class="bg" stop-opacity="0" />
      <stop offset="98%" class="bg" stop-opacity="1" />
    </linearGradient>
  </defs>

  <style>
    text { font-family: ui-monospace, 'JetBrains Mono', 'Fira Code', 'Iosevka', SFMono-Regular, 'SF Mono', Menlo, Consolas, 'Liberation Mono', monospace; font-size: 14px; font-display: swap; white-space: pre; }
    tspan { white-space: pre; }

    .bold { font-weight: bold; }
    .italic { font-style: italic; }
    .underline { text-decoration-line: underline; }
    .dim { opacity: 0.75; }
    .terminal { font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; font-weight: 500; font-size: 15px; }

    text { fill: #F5F5F5; }
    .terminal { fill: #DDD; }
    .bg { fill: #222; stop-color: #222; }
    .window { fill: #2A2A2A; }
    tspan.r { fill: #D22424; }
    tspan.g { fill: #6DCB21; }
    tspan.y { fill: #DAC425; }
    tspan.b { fill: #5C9AD8; }
    tspan.m { fill: #B6419E; }
    tspan.c { fill: #38AFC5; }
    tspan.LG { fill: #AAA; }
    tspan.DG { fill: #696969; }
    tspan.R { fill: #EF5A56; }
    tspan.G { fill: #49E471; }
    tspan.Y { fill: #E3E342; }
    tspan.B { fill: #7AAAE4; }
    tspan.M { fill: #B853D9; }
    tspan.C { fill: #5FD5DE; }
    tspan.W { fill: #BEBEBE; }
    ::-moz-selection { color: #CCC; fill: #CCC; background: #444; }
    ::selection { color: #CCC; fill: #CCC; background: #444; }

  </style>

  <rect width="830" height="952" x="0" y="0" rx="10" ry="10" class="bg" />
  <path class="window" d="M0 8a8 8 0 0 1 8-8h810a8 8 0 0 1 8 8v28H0V8Z" />
  <path class="window" d="M0 10C0 4.477 4.477 0 10 0h810c5.523 0 10 4.477 10 10v26H0V10Z" />

  <circle r="6" cx="16" cy="18" fill="#FC615D" />
  <circle r="6" cx="32" cy="18" fill="#FDBE41" />
  <circle r="6" cx="48" cy="18" fill="#34C84A" />

  <text x="50%" y="24" text-anchor="middle"><tspan class="terminal">Terminal</tspan></text>

  <text x="12" y="60"><tspan class="bold">Usage:</tspan> <tspan class="bold ">artefactor</tspan> <tspan class="g">{options}</tspan> <tspan class="y">{command}</tspan></text>
  <text x="12" y="100"><tspan class="bold">Commands</tspan></text>
  <text x="12" y="140">  <tspan class="y">download</tspan> <tspan class="LG">dir</tspan> <tspan class="DG">artefact</tspan> <tspan class="DG">.....</tspan> Download and store artefacts</text>
  <text x="12" y="160">  <tspan class="y">list</tspan> <tspan class="LG">dir/storage</tspan> <tspan class="DG">..........</tspan> List artefacts</text>
  <text x="12" y="180">  <tspan class="y">get</tspan> <tspan class="LG">storage</tspan> <tspan class="LG">name</tspan> <tspan class="DG">version</tspan> <tspan class="DG">..</tspan> Download artefact</text>
  <text x="12" y="200">  <tspan class="y">cleanup</tspan> <tspan class="LG">dir</tspan> <tspan class="LG">min-versions</tspan> <tspan class="DG">..</tspan> Remove outdated artefacts</text>
  <text x="12" y="240"><tspan class="bold">Options</tspan></text>
  <text x="12" y="280">  <tspan class="g">--sources</tspan><tspan class="LG">, </tspan><tspan class="g">-s</tspan> <tspan class="LG">file</tspan> <tspan class="DG">..</tspan> Path to YAML file with sources <tspan class="DG">(default: artefacts.yml)</tspan></text>
  <text x="12" y="300">  <tspan class="g">--token</tspan><tspan class="LG">, </tspan><tspan class="g">-t</tspan> <tspan class="LG">token</tspan> <tspan class="DG">...</tspan> GitHub personal token</text>
  <text x="12" y="320">  <tspan class="g">--install</tspan><tspan class="LG">, </tspan><tspan class="g">-I</tspan> <tspan class="DG">.......</tspan> Install artefact to user binaries <tspan class="DG">($HOME/.bin)</tspan></text>
  <text x="12" y="340">  <tspan class="g">--unit</tspan><tspan class="LG">, </tspan><tspan class="g">-u</tspan> <tspan class="DG">..........</tspan> Run application in unit mode <tspan class="DG">(no colors and animations)</tspan></text>
  <text x="12" y="360">  <tspan class="g">--no-color</tspan><tspan class="LG">, </tspan><tspan class="g">-nc</tspan> <tspan class="DG">.....</tspan> Disable colors in output</text>
  <text x="12" y="380">  <tspan class="g">--help</tspan><tspan class="LG">, </tspan><tspan class="g">-h</tspan> <tspan class="DG">..........</tspan> Show this help message</text>
  <text x="12" y="400">  <tspan class="g">--version</tspan><tspan class="LG">, </tspan><tspan class="g">-v</tspan> <tspan class="DG">.......</tspan> Show version</text>
  <text x="12" y="440"><tspan class="bold">Examples</tspan></text>
  <text x="12" y="480">  artefactor download data</text>
  <text x="12" y="500">  <tspan class="italic DG">Download artefacts to &#34;data&#34; directory</tspan></text>
  <text x="12" y="540">  artefactor download data --source ~/artefacts-all.yml</text>
  <text x="12" y="560">  <tspan class="italic DG">Download artefacts from given file to &#34;data&#34; directory</tspan></text>
  <text x="12" y="600">  artefactor download data --name shellcheck</text>
  <text x="12" y="620">  <tspan class="italic DG">Download shellcheck artefacts to data directory</tspan></text>
  <text x="12" y="660">  artefactor list data</text>
  <text x="12" y="680">  <tspan class="italic DG">List all artefacts in &#34;data&#34; directory</tspan></text>
  <text x="12" y="720">  artefactor list my.artefacts.storage</text>
  <text x="12" y="740">  <tspan class="italic DG">List all artefacts on remote storage</tspan></text>
  <text x="12" y="780">  artefactor cleanup data 10</text>
  <text x="12" y="800">  <tspan class="italic DG">Cleanup artefacts versions in &#34;data&#34; directory except the last 10</tspan></text>
  <text x="12" y="840">  artefactor get my.artefacts.storage myapp</text>
  <text x="12" y="860">  <tspan class="italic DG">Download the latest version of myapp files from remote storage</tspan></text>
  <text x="12" y="900">  artefactor get my.artefacts.storage myapp 1.0.0</text>
  <text x="12" y="920">  <tspan class="italic DG">Download myapp version 1.0.0 files from remote storage</tspan></text>

  <rect x="800" y="36" width="30.3" height="902" fill="url(#fog)"/>
</svg>