.github/images/usage-container.svg

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

  <title>Atlassian Cloud Backuper 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: #333; }
    .terminal { fill: #333; }
    .bg { fill: #F0F0F0; stop-color: #F0F0F0; }
    .window { fill: #E5E5E5; }
    tspan.r { fill: #BA0000; }
    tspan.g { fill: #53B900; }
    tspan.y { fill: #BA9B00; }
    tspan.b { fill: #0060BA; }
    tspan.m { fill: #BA00AD; }
    tspan.c { fill: #00B7BA; }
    tspan.s { fill: #696969; }
    tspan.d { fill: #AAA; }
    tspan.R { fill: #EA4B4B; }
    tspan.G { fill: #88DB43; }
    tspan.Y { fill: #D3BA3B; }
    tspan.B { fill: #3890E2; }
    tspan.M { fill: #DB3BD0; }
    tspan.C { fill: #39D8DB; }
    tspan.W { fill: #BEBEBE; }
    ::-moz-selection { color: #222; fill: #222; background: #CCC; }
    ::selection { color: #222; fill: #222; background: #CCC; }

    @media (prefers-color-scheme: dark) {
    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="855" height="1012" x="0" y="0" rx="10" ry="10" class="bg" />
  <path class="window" d="M0 8a8 8 0 0 1 8-8h835a8 8 0 0 1 8 8v28H0V8Z" />
  <path class="window" d="M0 10C0 4.477 4.477 0 10 0h835c5.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="#0065FF">atlassian-cloud-backuper</tspan> <tspan class="g">{options}</tspan> <tspan class="s">target</tspan></text>
  <text x="12" y="100"><tspan class="BB">Options</tspan></text>
  <text x="12" y="140">  <tspan class="g">--config</tspan><tspan class="s">, </tspan><tspan class="g">-c</tspan> <tspan class="s">file</tspan> <tspan class="d">........................</tspan> Path to configuration file</text>
  <text x="12" y="160">  <tspan class="g">--interactive</tspan><tspan class="s">, </tspan><tspan class="g">-I</tspan> <tspan class="d">........................</tspan> Interactive mode</text>
  <text x="12" y="180">  <tspan class="g">--server</tspan><tspan class="s">, </tspan><tspan class="g">-S</tspan> <tspan class="d">.............................</tspan> Server mode</text>
  <text x="12" y="200">  <tspan class="g">--force</tspan><tspan class="s">, </tspan><tspan class="g">-F</tspan> <tspan class="d">..............................</tspan> Force backup generation</text>
  <text x="12" y="220">  <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="240">  <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="260">  <tspan class="g">--version</tspan><tspan class="s">, </tspan><tspan class="g">-v</tspan> <tspan class="d">............................</tspan> Show version</text>
  <text x="12" y="280">  <tspan class="b">--access-account</tspan> <tspan class="s">name</tspan> <tspan class="d">....................</tspan> Account name <tspan class="d">(ACCESS_ACCOUNT)</tspan></text>
  <text x="12" y="300">  <tspan class="b">--access-email</tspan> <tspan class="s">email</tspan> <tspan class="d">.....................</tspan> User email with access to API <tspan class="d">(ACCESS_EMAIL)</tspan></text>
  <text x="12" y="320">  <tspan class="b">--access-api-key</tspan> <tspan class="s">key</tspan> <tspan class="d">.....................</tspan> API key <tspan class="d">(ACCESS_API_KEY)</tspan></text>
  <text x="12" y="340">  <tspan class="b">--server-ip</tspan> <tspan class="s">ip</tspan> <tspan class="d">...........................</tspan> HTTP server IP <tspan class="d">(SERVER_IP)</tspan></text>
  <text x="12" y="360">  <tspan class="b">--server-port</tspan> <tspan class="s">port</tspan> <tspan class="d">.......................</tspan> HTTP server port <tspan class="d">(SERVER_PORT)</tspan></text>
  <text x="12" y="380">  <tspan class="b">--server-access-token</tspan> <tspan class="s">token</tspan> <tspan class="d">..............</tspan> HTTP access token <tspan class="d">(SERVER_ACCESS_TOKEN)</tspan></text>
  <text x="12" y="400">  <tspan class="b">--storage-type</tspan> <tspan class="s">fs/sftp/s3</tspan> <tspan class="d">................</tspan> Storage type <tspan class="d">(STORAGE_TYPE)</tspan></text>
  <text x="12" y="420">  <tspan class="b">--storage-encryption-key</tspan> <tspan class="s">key</tspan> <tspan class="d">.............</tspan> Data encryption key <tspan class="d">(STORAGE_ENCRYPTION_KEY)</tspan></text>
  <text x="12" y="440">  <tspan class="b">--storage-fs-path</tspan> <tspan class="s">path</tspan> <tspan class="d">...................</tspan> Path on system for backups <tspan class="d">(STORAGE_FS_PATH)</tspan></text>
  <text x="12" y="460">  <tspan class="b">--storage-fs-mode</tspan> <tspan class="s">mode</tspan> <tspan class="d">...................</tspan> File mode on system <tspan class="d">(STORAGE_FS_MODE)</tspan></text>
  <text x="12" y="480">  <tspan class="b">--storage-sftp-host</tspan> <tspan class="s">host</tspan> <tspan class="d">.................</tspan> SFTP host <tspan class="d">(STORAGE_SFTP_HOST)</tspan></text>
  <text x="12" y="500">  <tspan class="b">--storage-sftp-user</tspan> <tspan class="s">name</tspan> <tspan class="d">.................</tspan> SFTP user name <tspan class="d">(STORAGE_SFTP_USER)</tspan></text>
  <text x="12" y="520">  <tspan class="b">--storage-sftp-key</tspan> <tspan class="s">key</tspan> <tspan class="d">...................</tspan> Base64-encoded private key <tspan class="d">(STORAGE_SFTP_KEY)</tspan></text>
  <text x="12" y="540">  <tspan class="b">--storage-sftp-path</tspan> <tspan class="s">path</tspan> <tspan class="d">.................</tspan> Path on SFTP <tspan class="d">(STORAGE_SFTP_PATH)</tspan></text>
  <text x="12" y="560">  <tspan class="b">--storage-sftp-mode</tspan> <tspan class="s">mode</tspan> <tspan class="d">.................</tspan> File mode on SFTP <tspan class="d">(STORAGE_SFTP_MODE)</tspan></text>
  <text x="12" y="580">  <tspan class="b">--storage-s3-host</tspan> <tspan class="s">host</tspan> <tspan class="d">...................</tspan> S3 host <tspan class="d">(STORAGE_S3_HOST)</tspan></text>
  <text x="12" y="600">  <tspan class="b">--storage-s3-region</tspan> <tspan class="s">region</tspan> <tspan class="d">...............</tspan> S3 region <tspan class="d">(STORAGE_S3_REGION)</tspan></text>
  <text x="12" y="620">  <tspan class="b">--storage-s3-access-key</tspan> <tspan class="s">id</tspan> <tspan class="d">...............</tspan> S3 access key ID <tspan class="d">(STORAGE_S3_ACCESS_KEY)</tspan></text>
  <text x="12" y="640">  <tspan class="b">--storage-s3-secret-key</tspan> <tspan class="s">key</tspan> <tspan class="d">..............</tspan> S3 access secret key <tspan class="d">(STORAGE_S3_SECRET_KEY)</tspan></text>
  <text x="12" y="660">  <tspan class="b">--storage-s3-bucket</tspan> <tspan class="s">name</tspan> <tspan class="d">.................</tspan> S3 bucket <tspan class="d">(STORAGE_S3_BUCKET)</tspan></text>
  <text x="12" y="680">  <tspan class="b">--storage-s3-path</tspan> <tspan class="s">path</tspan> <tspan class="d">...................</tspan> Path for backups <tspan class="d">(STORAGE_S3_PATH)</tspan></text>
  <text x="12" y="700">  <tspan class="b">--storage-s3-part-size</tspan> <tspan class="s">num</tspan> <tspan class="d">...............</tspan> Uploading part size (in MB) <tspan class="d">(STORAGE_S3_PART_SIZE)</tspan></text>
  <text x="12" y="720">  <tspan class="b">--jira-output-file</tspan> <tspan class="s">template</tspan> <tspan class="d">..............</tspan> Jira backup output file name template</text>
  <text x="12" y="740">                                             <tspan class="d">(JIRA_OUTPUT_FILE)</tspan></text>
  <text x="12" y="760">  <tspan class="b">--jira-include-attachments</tspan> <tspan class="s">yes/no</tspan> <tspan class="d">........</tspan> Include attachments to Jira backup</text>
  <text x="12" y="780">                                             <tspan class="d">(JIRA_INCLUDE_ATTACHMENTS)</tspan></text>
  <text x="12" y="800">  <tspan class="b">--jira-cloud-format</tspan> <tspan class="s">yes/no</tspan> <tspan class="d">...............</tspan> Create Jira backup for Cloud <tspan class="d">(JIRA_CLOUD_FORMAT)</tspan></text>
  <text x="12" y="820">  <tspan class="b">--confluence-output-file</tspan> <tspan class="s">template</tspan> <tspan class="d">........</tspan> Confluence backup output file name template</text>
  <text x="12" y="840">                                             <tspan class="d">(CONFLUENCE_OUTPUT_FILE)</tspan></text>
  <text x="12" y="860">  <tspan class="b">--confluence-include-attachments</tspan> <tspan class="s">yes/no</tspan> <tspan class="d">..</tspan> Include attachments to Confluence backup</text>
  <text x="12" y="880">                                             <tspan class="d">(CONFLUENCE_INCLUDE_ATTACHMENTS)</tspan></text>
  <text x="12" y="900">  <tspan class="b">--confluence-cloud-format</tspan> <tspan class="s">yes/no</tspan> <tspan class="d">.........</tspan> Create Confluence backup for Cloud</text>
  <text x="12" y="920">                                             <tspan class="d">(CONFLUENCE_CLOUD_FORMAT)</tspan></text>
  <text x="12" y="940">  <tspan class="b">--temp-dir</tspan> <tspan class="s">path</tspan> <tspan class="d">..........................</tspan> Path to directory for temporary data <tspan class="d">(TEMP_DIR)</tspan></text>
  <text x="12" y="960">  <tspan class="b">--log-format</tspan> <tspan class="s">text/json</tspan> <tspan class="d">...................</tspan> Log format <tspan class="d">(LOG_FORMAT)</tspan></text>
  <text x="12" y="980">  <tspan class="b">--log-level</tspan> <tspan class="s">level</tspan> <tspan class="d">........................</tspan> Log level <tspan class="d">(LOG_LEVEL)</tspan></text>

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