.github/images/usage.svg

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

  <title>RDS 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; }

    .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; }

    tspan.BB { font-weight: bold; }
    tspan.II { font-style: italic; }
    tspan.UU { text-decoration-line: underline; }
    tspan.DD { opacity: 0.75; }

    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.s { fill: #AAA; }
    tspan.d { 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="1972" 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="BB">Usage:</tspan> <tspan class="BB" fill="#DC382C">rds</tspan> <tspan class="g">{options}</tspan> <tspan class="y">{command}</tspan></text>
  <text x="12" y="100"><tspan class="BB">Basic commands</tspan></text>
  <text x="12" y="140">  <tspan class="y">create</tspan> <tspan class="d">...................</tspan> Create new Redis instance</text>
  <text x="12" y="160">  <tspan class="y">destroy</tspan> <tspan class="s">id</tspan> <tspan class="d">...............</tspan> Destroy <tspan class="s">(delete)</tspan> Redis instance</text>
  <text x="12" y="180">  <tspan class="y">edit</tspan> <tspan class="s">id</tspan> <tspan class="d">..................</tspan> Edit metadata for instance</text>
  <text x="12" y="200">  <tspan class="y">start</tspan> <tspan class="s">id</tspan> <tspan class="d">.................</tspan> Start Redis instance</text>
  <text x="12" y="220">  <tspan class="y">stop</tspan> <tspan class="s">id</tspan> <tspan class="d">force</tspan> <tspan class="d">............</tspan> Stop Redis instance</text>
  <text x="12" y="240">  <tspan class="y">restart</tspan> <tspan class="s">id</tspan> <tspan class="d">...............</tspan> Restart Redis instance</text>
  <text x="12" y="260">  <tspan class="y">kill</tspan> <tspan class="s">id</tspan> <tspan class="d">..................</tspan> Kill Redis instance</text>
  <text x="12" y="280">  <tspan class="y">status</tspan> <tspan class="s">id</tspan> <tspan class="d">................</tspan> Show current status of Redis instance</text>
  <text x="12" y="300">  <tspan class="y">cli</tspan> <tspan class="s">id:db</tspan> <tspan class="d">command</tspan> <tspan class="d">........</tspan> Run CLI connected to Redis instance</text>
  <text x="12" y="320">  <tspan class="y">cpu</tspan> <tspan class="s">id</tspan> <tspan class="d">period</tspan> <tspan class="d">............</tspan> Calculate instance CPU usage</text>
  <text x="12" y="340">  <tspan class="y">memory</tspan> <tspan class="s">id</tspan> <tspan class="d">................</tspan> Show instance memory usage</text>
  <text x="12" y="360">  <tspan class="y">info</tspan> <tspan class="s">id</tspan> <tspan class="d">section…</tspan> <tspan class="d">.........</tspan> Show system info about Redis instance</text>
  <text x="12" y="380">  <tspan class="y">stats-command</tspan> <tspan class="s">id</tspan> <tspan class="d">.........</tspan> Show statistics based on the command type</text>
  <text x="12" y="400">  <tspan class="y">stats-latency</tspan> <tspan class="s">id</tspan> <tspan class="d">.........</tspan> Show latency statistics based on the command type</text>
  <text x="12" y="420">  <tspan class="y">stats-error</tspan> <tspan class="s">id</tspan> <tspan class="d">...........</tspan> Show error statistics</text>
  <text x="12" y="440">  <tspan class="y">clients</tspan> <tspan class="s">id</tspan> <tspan class="d">filter</tspan> <tspan class="d">........</tspan> Show list of connected clients</text>
  <text x="12" y="460">  <tspan class="y">track</tspan> <tspan class="s">id</tspan> <tspan class="d">interval</tspan> <tspan class="d">........</tspan> Show interactive info about Redis instance</text>
  <text x="12" y="480">  <tspan class="y">conf</tspan> <tspan class="s">id</tspan> <tspan class="d">filter…</tspan> <tspan class="d">..........</tspan> Show configuration of Redis instance</text>
  <text x="12" y="500">  <tspan class="y">list</tspan> <tspan class="d">filter…</tspan> <tspan class="d">.............</tspan> Show list of all Redis instances</text>
  <text x="12" y="520">  <tspan class="y">log</tspan> <tspan class="s">source</tspan> <tspan class="d">...............</tspan> Show RDS or Redis instance logs</text>
  <text x="12" y="540">  <tspan class="y">stats</tspan> <tspan class="d">....................</tspan> Show overall statistics</text>
  <text x="12" y="560">  <tspan class="y">top</tspan> <tspan class="d">field</tspan> <tspan class="d">num</tspan> <tspan class="d">............</tspan> Show instances top</text>
  <text x="12" y="580">  <tspan class="y">top-diff</tspan> <tspan class="s">file</tspan> <tspan class="d">field</tspan> <tspan class="d">num</tspan> <tspan class="d">..</tspan> Compare current and dumped top data</text>
  <text x="12" y="600">  <tspan class="y">top-dump</tspan> <tspan class="s">file</tspan> <tspan class="d">............</tspan> Dump top data to file</text>
  <text x="12" y="620">  <tspan class="y">uptime</tspan> <tspan class="d">...................</tspan> Show instances uptime info</text>
  <text x="12" y="640">  <tspan class="y">slowlog-get</tspan> <tspan class="s">id</tspan> <tspan class="d">num</tspan> <tspan class="d">.......</tspan> Show last entries from slow log</text>
  <text x="12" y="660">  <tspan class="y">slowlog-reset</tspan> <tspan class="s">id</tspan> <tspan class="d">.........</tspan> Clear slow log</text>
  <text x="12" y="680">  <tspan class="y">tag-add</tspan> <tspan class="s">id</tspan> <tspan class="s">tag</tspan> <tspan class="d">...........</tspan> Add tag to instance</text>
  <text x="12" y="700">  <tspan class="y">tag-remove</tspan> <tspan class="s">id</tspan> <tspan class="s">tag</tspan> <tspan class="d">........</tspan> Remove tag from instance</text>
  <text x="12" y="720">  <tspan class="y">check</tspan> <tspan class="d">....................</tspan> Check for dead instances</text>
  <text x="12" y="760"><tspan class="BB">Backup commands</tspan></text>
  <text x="12" y="800">  <tspan class="y">backup-create</tspan> <tspan class="s">id</tspan> <tspan class="d">...</tspan> Create snapshot of RDB file</text>
  <text x="12" y="820">  <tspan class="y">backup-restore</tspan> <tspan class="s">id</tspan> <tspan class="d">..</tspan> Restore instance data from snapshot</text>
  <text x="12" y="840">  <tspan class="y">backup-clean</tspan> <tspan class="s">id</tspan> <tspan class="d">....</tspan> Remove all backup snapshots</text>
  <text x="12" y="860">  <tspan class="y">backup-list</tspan> <tspan class="s">id</tspan> <tspan class="d">.....</tspan> List backup snapshots</text>
  <text x="12" y="900"><tspan class="BB">Superuser commands</tspan></text>
  <text x="12" y="940">  <tspan class="y">go</tspan> <tspan class="d">.....................</tspan> Generate superuser access credentials</text>
  <text x="12" y="960">  <tspan class="y">batch-create</tspan> <tspan class="s">csv-file</tspan> <tspan class="d">..</tspan> Create many instances at once</text>
  <text x="12" y="980">  <tspan class="y">batch-edit</tspan> <tspan class="s">id…</tspan> <tspan class="d">.........</tspan> Edit many instances at once</text>
  <text x="12" y="1000">  <tspan class="y">stop-all</tspan> <tspan class="d">...............</tspan> Stop all instances</text>
  <text x="12" y="1020">  <tspan class="y">start-all</tspan> <tspan class="d">..............</tspan> Start all instances</text>
  <text x="12" y="1040">  <tspan class="y">restart-all</tspan> <tspan class="d">............</tspan> Restart all instances</text>
  <text x="12" y="1060">  <tspan class="y">reload</tspan> <tspan class="s">id</tspan> <tspan class="d">..............</tspan> Reload configuration for one or all instances</text>
  <text x="12" y="1080">  <tspan class="y">regen</tspan> <tspan class="s">id</tspan> <tspan class="d">...............</tspan> Regenerate configuration file for one or all instances</text>
  <text x="12" y="1100">  <tspan class="y">state-save</tspan> <tspan class="s">file</tspan> <tspan class="d">........</tspan> Save state of all instances</text>
  <text x="12" y="1120">  <tspan class="y">state-restore</tspan> <tspan class="d">file</tspan> <tspan class="d">.....</tspan> Restore state of all instances</text>
  <text x="12" y="1140">  <tspan class="y">maintenance</tspan> <tspan class="s">flag</tspan> <tspan class="d">.......</tspan> Enable or disable maintenance mode</text>
  <text x="12" y="1180"><tspan class="BB">Replication commands</tspan></text>
  <text x="12" y="1220">  <tspan class="y">replication</tspan> <tspan class="d">.......................</tspan> Show replication info</text>
  <text x="12" y="1240">  <tspan class="y">replication-role-set</tspan> <tspan class="s">target-role</tspan> <tspan class="d">..</tspan> Change node role</text>
  <text x="12" y="1280"><tspan class="BB">Sentinel commands</tspan></text>
  <text x="12" y="1320">  <tspan class="y">sentinel-start</tspan> <tspan class="d">.............</tspan> Start Redis Sentinel daemon</text>
  <text x="12" y="1340">  <tspan class="y">sentinel-stop</tspan> <tspan class="d">..............</tspan> Stop Redis Sentinel daemon</text>
  <text x="12" y="1360">  <tspan class="y">sentinel-status</tspan> <tspan class="d">............</tspan> Show status of Redis Sentinel daemon</text>
  <text x="12" y="1380">  <tspan class="y">sentinel-info</tspan> <tspan class="s">id</tspan> <tspan class="d">...........</tspan> Show info from Sentinel for some instance</text>
  <text x="12" y="1400">  <tspan class="y">sentinel-master</tspan> <tspan class="s">id</tspan> <tspan class="d">.........</tspan> Show IP of master instance</text>
  <text x="12" y="1420">  <tspan class="y">sentinel-check</tspan> <tspan class="s">id</tspan> <tspan class="d">..........</tspan> Check Sentinel configuration</text>
  <text x="12" y="1440">  <tspan class="y">sentinel-reset</tspan> <tspan class="d">.............</tspan> Reset state in Sentinel for all instances</text>
  <text x="12" y="1460">  <tspan class="y">sentinel-switch-master</tspan> <tspan class="s">id</tspan> <tspan class="d">..</tspan> Switch instance to master role</text>
  <text x="12" y="1500"><tspan class="BB">Common commands</tspan></text>
  <text x="12" y="1540">  <tspan class="y">help</tspan> <tspan class="s">command</tspan> <tspan class="d">........</tspan> Show command usage info</text>
  <text x="12" y="1560">  <tspan class="y">settings</tspan> <tspan class="d">section…</tspan> <tspan class="d">...</tspan> Show settings from global configuration file</text>
  <text x="12" y="1580">  <tspan class="y">gen-token</tspan> <tspan class="d">...........</tspan> Generate authentication token for sync daemon</text>
  <text x="12" y="1600">  <tspan class="y">validate-templates</tspan> <tspan class="d">..</tspan> Validate Redis and Sentinel templates</text>
  <text x="12" y="1640"><tspan class="BB">Options</tspan></text>
  <text x="12" y="1680">  <tspan class="g">--secure</tspan><tspan class="s">, </tspan><tspan class="g">-s</tspan> <tspan class="d">............</tspan> Create secure Redis instance with auth support (<tspan class="y">create</tspan>)</text>
  <text x="12" y="1700">  <tspan class="g">--disable-saves</tspan><tspan class="s">, </tspan><tspan class="g">-ds</tspan> <tspan class="d">....</tspan> Disable saves for created instance (<tspan class="y">create</tspan>)</text>
  <text x="12" y="1720">  <tspan class="g">--private</tspan><tspan class="s">, </tspan><tspan class="g">-p</tspan> <tspan class="d">...........</tspan> Force access to private data (<tspan class="y">conf</tspan>/<tspan class="y">cli</tspan>/<tspan class="y">settings</tspan>)</text>
  <text x="12" y="1740">  <tspan class="g">--extra</tspan><tspan class="s">, </tspan><tspan class="g">-x</tspan> <tspan class="d">.............</tspan> Print extra info (<tspan class="y">list</tspan>)</text>
  <text x="12" y="1760">  <tspan class="g">--tags</tspan><tspan class="s">, </tspan><tspan class="g">-t</tspan> <tspan class="s">tag…</tspan> <tspan class="d">.........</tspan> List of tags (<tspan class="y">create</tspan>)</text>
  <text x="12" y="1780">  <tspan class="g">--format</tspan><tspan class="s">, </tspan><tspan class="g">-f</tspan> <tspan class="s">format</tspan> <tspan class="d">.....</tspan> Output format <tspan class="d">(text/json/xml)</tspan></text>
  <text x="12" y="1800">  <tspan class="g">--yes</tspan><tspan class="s">, </tspan><tspan class="g">-y</tspan> <tspan class="d">...............</tspan> Automatically answer yes for all questions</text>
  <text x="12" y="1820">  <tspan class="g">--pager</tspan><tspan class="s">, </tspan><tspan class="g">-P</tspan> <tspan class="d">.............</tspan> Enable pager for long output</text>
  <text x="12" y="1840">  <tspan class="g">--simple</tspan><tspan class="s">, </tspan><tspan class="g">-S</tspan> <tspan class="d">............</tspan> Simplify output <tspan class="d">(useful for copy-paste)</tspan></text>
  <text x="12" y="1860">  <tspan class="g">--raw</tspan><tspan class="s">, </tspan><tspan class="g">-R</tspan> <tspan class="d">...............</tspan> Force raw output <tspan class="d">(useful for scripts)</tspan></text>
  <text x="12" y="1880">  <tspan class="g">--no-color</tspan><tspan class="s">, </tspan><tspan class="g">-nc</tspan> <tspan class="d">.........</tspan> Disable colors in output</text>
  <text x="12" y="1900">  <tspan class="g">--help</tspan><tspan class="s">, </tspan><tspan class="g">-h</tspan> <tspan class="d">..............</tspan> Show this help message</text>
  <text x="12" y="1920">  <tspan class="g">--version</tspan><tspan class="s">, </tspan><tspan class="g">-v</tspan> <tspan class="d">...........</tspan> Show information about version</text>
  <text x="12" y="1940">  <tspan class="g">--verbose-version</tspan><tspan class="s">, </tspan><tspan class="g">-vv</tspan> <tspan class="d">..</tspan> Show verbose information about version</text>

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