{
  "name": "surreal",
  "description": "SurrealDB is the ultimate cloud database for tomorrow's applications - https://surrealdb.com/",
  "subcommands": [
    {
      "name": "help",
      "description": "Print this message or the help of the given subcommand(s)",
      "args": [
        {
          "name": "command",
          "description": "Command to get help for"
        }
      ]
    },
    {
      "name": "start",
      "description": "Start the database server",
      "options": [
        {
          "names": [
            "--"
          ],
          "description": "Everything after this is an argument"
        },
        {
          "names": [
            "--addr"
          ],
          "description": "The allowed networks for master authentication [env: ADDR=] [default: 127.0.0.1/32]",
          "takes_arg": true,
          "arg": {
            "name": "addr",
            "description": "The allowed networks for master authentication [env: ADDR=] [default: 127.0.0.1/32]"
          }
        },
        {
          "names": [
            "--bind",
            "-b"
          ],
          "description": "The hostname or ip address to listen for connections on [env: BIND=] [default: 0.0.0.0:8000]",
          "takes_arg": true,
          "arg": {
            "name": "bind",
            "description": "The hostname or ip address to listen for connections on [env: BIND=] [default: 0.0.0.0:8000]"
          }
        },
        {
          "names": [
            "--key",
            "-k"
          ],
          "description": "Encryption key to use for on-disk encryption [env: KEY=]",
          "takes_arg": true,
          "arg": {
            "name": "key",
            "description": "Encryption key to use for on-disk encryption [env: KEY=]"
          }
        },
        {
          "names": [
            "--kvs-ca"
          ],
          "description": "Path to the CA file used when connecting to the remote KV store [env: KVS_CA=]",
          "takes_arg": true,
          "arg": {
            "name": "kvs-ca",
            "description": "Path to the CA file used when connecting to the remote KV store [env: KVS_CA=]"
          }
        },
        {
          "names": [
            "--kvs-crt"
          ],
          "description": "Path to the certificate file used when connecting to the remote KV store [env: KVS_CRT=]",
          "takes_arg": true,
          "arg": {
            "name": "kvs-crt",
            "description": "Path to the certificate file used when connecting to the remote KV store [env: KVS_CRT=]"
          }
        },
        {
          "names": [
            "--kvs-key"
          ],
          "description": "Path to the private key file used when connecting to the remote KV store [env: KVS_KEY=]",
          "takes_arg": true,
          "arg": {
            "name": "kvs-key",
            "description": "Path to the private key file used when connecting to the remote KV store [env: KVS_KEY=]"
          }
        },
        {
          "names": [
            "--log",
            "-l"
          ],
          "description": "The logging level for the database server [env: LOG=] [default: info] [possible values: warn, info, debug, trace, full]",
          "takes_arg": true,
          "arg": {
            "name": "log",
            "description": "The logging level for the database server [env: LOG=] [default: info] [possible values: warn, info, debug, trace, full]",
            "suggestions": [
              "warn",
              "info",
              "debug",
              "trace",
              "full"
            ]
          }
        },
        {
          "names": [
            "--pass",
            "-p"
          ],
          "description": "The master password for the database [env: PASS=]",
          "takes_arg": true,
          "arg": {
            "name": "pass",
            "description": "The master password for the database [env: PASS=]"
          }
        },
        {
          "names": [
            "--strict",
            "-s"
          ],
          "description": "Whether strict mode is enabled on this database instance [env: STRICT=]",
          "takes_arg": true,
          "arg": {
            "name": "strict",
            "description": "Whether strict mode is enabled on this database instance [env: STRICT=]"
          }
        },
        {
          "names": [
            "--user",
            "-u"
          ],
          "description": "The master username for the database [env: USER=] [default: root]",
          "takes_arg": true,
          "arg": {
            "name": "user",
            "description": "The master username for the database [env: USER=] [default: root]"
          }
        },
        {
          "names": [
            "--web-crt"
          ],
          "description": "Path to the certificate file for encrypted client connections [env: WEB_CRT=]",
          "takes_arg": true,
          "arg": {
            "name": "web-crt",
            "description": "Path to the certificate file for encrypted client connections [env: WEB_CRT=]"
          }
        },
        {
          "names": [
            "--web-key"
          ],
          "description": "Path to the private key file for encrypted client connections [env: WEB_KEY=]",
          "takes_arg": true,
          "arg": {
            "name": "web-key",
            "description": "Path to the private key file for encrypted client connections [env: WEB_KEY=]"
          }
        }
      ],
      "args": [
        {
          "name": "path",
          "description": "Database path used for storing data [env: DB_PATH=] [default: memory]"
        }
      ]
    },
    {
      "name": "backup",
      "description": "Backup data to or from an existing database",
      "options": [
        {
          "names": [
            "--pass",
            "-p"
          ],
          "description": "Database authentication password to use when connecting [default: root]",
          "takes_arg": true,
          "arg": {
            "name": "pass",
            "description": "Database authentication password to use when connecting [default: root]"
          }
        },
        {
          "names": [
            "--user",
            "-u"
          ],
          "description": "Database authentication username to use when connecting [default: root]",
          "takes_arg": true,
          "arg": {
            "name": "user",
            "description": "Database authentication username to use when connecting [default: root]"
          }
        }
      ],
      "args": [
        {
          "name": "from",
          "description": "Path to the remote database or file from which to export"
        },
        {
          "name": "into",
          "description": "Path to the remote database or file into which to import"
        }
      ]
    },
    {
      "name": "import",
      "description": "Import a SurrealQL script into an existing database",
      "options": [
        {
          "names": [
            "--pass",
            "-p"
          ],
          "description": "Database authentication password to use when connecting [default: root]",
          "takes_arg": true,
          "arg": {
            "name": "pass",
            "description": "Database authentication password to use when connecting [default: root]"
          }
        },
        {
          "names": [
            "--user",
            "-u"
          ],
          "description": "Database authentication username to use when connecting [default: root]",
          "takes_arg": true,
          "arg": {
            "name": "user",
            "description": "Database authentication username to use when connecting [default: root]"
          }
        },
        {
          "names": [
            "--conn",
            "-c"
          ],
          "description": "Remote database server url to connect to [default: https://cloud.surrealdb.com]",
          "takes_arg": true,
          "arg": {
            "name": "conn",
            "description": "Remote database server url to connect to [default: https://cloud.surrealdb.com]"
          }
        },
        {
          "names": [
            "--ns"
          ],
          "description": "The namespace to import the data into",
          "takes_arg": true,
          "arg": {
            "name": "ns",
            "description": "The namespace to import the data into"
          },
          "is_required": true
        },
        {
          "names": [
            "--db"
          ],
          "description": "The database to import the data into",
          "takes_arg": true,
          "arg": {
            "name": "db",
            "description": "The database to import the data into"
          },
          "is_required": true
        }
      ],
      "args": [
        {
          "name": "file",
          "description": "Path to the sql file to import"
        }
      ]
    },
    {
      "name": "export",
      "description": "Export an existing database as a SurrealQL script",
      "options": [
        {
          "names": [
            "--pass",
            "-p"
          ],
          "description": "Database authentication password to use when connecting [default: root]",
          "takes_arg": true,
          "arg": {
            "name": "pass",
            "description": "Database authentication password to use when connecting [default: root]"
          }
        },
        {
          "names": [
            "--user",
            "-u"
          ],
          "description": "Database authentication username to use when connecting [default: root]",
          "takes_arg": true,
          "arg": {
            "name": "user",
            "description": "Database authentication username to use when connecting [default: root]"
          }
        },
        {
          "names": [
            "--conn",
            "-c"
          ],
          "description": "Remote database server url to connect to [default: https://cloud.surrealdb.com]",
          "takes_arg": true,
          "arg": {
            "name": "conn",
            "description": "Remote database server url to connect to [default: https://cloud.surrealdb.com]"
          }
        },
        {
          "names": [
            "--ns"
          ],
          "description": "The namespace to export the data from",
          "takes_arg": true,
          "arg": {
            "name": "ns",
            "description": "The namespace to export the data from"
          },
          "is_required": true
        },
        {
          "names": [
            "--db"
          ],
          "description": "The database to export the data from",
          "takes_arg": true,
          "arg": {
            "name": "db",
            "description": "The database to export the data from"
          },
          "is_required": true
        }
      ],
      "args": [
        {
          "name": "file",
          "description": "Path to the sql file to export"
        }
      ]
    },
    {
      "name": "version",
      "description": "Output the command-line tool version information"
    },
    {
      "name": "sql",
      "description": "Start an SQL REPL in your terminal with pipe support",
      "options": [
        {
          "names": [
            "--pass",
            "-p"
          ],
          "description": "Database authentication password to use when connecting [default: root]",
          "takes_arg": true,
          "arg": {
            "name": "pass",
            "description": "Database authentication password to use when connecting [default: root]"
          }
        },
        {
          "names": [
            "--user",
            "-u"
          ],
          "description": "Database authentication username to use when connecting [default: root]",
          "takes_arg": true,
          "arg": {
            "name": "user",
            "description": "Database authentication username to use when connecting [default: root]"
          }
        },
        {
          "names": [
            "--conn",
            "-c"
          ],
          "description": "Remote database server url to connect to [default: https://cloud.surrealdb.com]",
          "takes_arg": true,
          "arg": {
            "name": "conn",
            "description": "Remote database server url to connect to [default: https://cloud.surrealdb.com]"
          }
        },
        {
          "names": [
            "--ns"
          ],
          "description": "The namespace to export the data from",
          "takes_arg": true,
          "arg": {
            "name": "ns",
            "description": "The namespace to export the data from"
          },
          "is_required": true
        },
        {
          "names": [
            "--db"
          ],
          "description": "The database to export the data from",
          "takes_arg": true,
          "arg": {
            "name": "db",
            "description": "The database to export the data from"
          },
          "is_required": true
        },
        {
          "names": [
            "--pretty"
          ],
          "description": "Whether database responses should be pretty printed"
        }
      ],
      "args": [
        {
          "name": "file",
          "description": "Path to the sql file to export"
        }
      ]
    }
  ],
  "options": [
    {
      "names": [
        "--help",
        "-h"
      ],
      "description": "Print help information"
    }
  ]
}
