overlane enterprise data export

Writes memory, derived text, vectors (metadata only), conversations, CI records, logs and, for the tenant scope, the audit log, one JSON record per line. Open to every plan.

Usage

overlane enterprise data export [--scope SCOPE] [--subject ID] [--out FILE] [--dry-run]

Flags

Flag	Type	Required	Default	Description
`--scope`	one of `tenant`, `project`, `user`	no	`tenant`	tenant (default), project or user
`--subject`	string	no		The project or user ID for a project or user scope
`--out`	string	no	`export.ndjson`	Where to write the file
`--dry-run`	boolean	no		Print the requests and file changes this command would make, then stop. Needs no credentials.

Examples

overlane enterprise data export --out export.ndjson
overlane enterprise data export --scope project --subject prj-1

Behavior

Effect: write (changes local or hosted state).
Needs credentials: yes. Uses the network: yes.
Supports --dry-run: yes. Accepts --force: no.
Machine-readable description: overlane schema enterprise data export.

Result

With --json (the default when stdout is not a terminal) the command prints this JSON Schema’s shape on stdout.

{
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "file": {
          "type": "string"
        },
        "totalRows": {
          "type": "number"
        },
        "stores": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "store": {
                "type": "string",
                "enum": [
                  "d1",
                  "r2",
                  "kv",
                  "durable_objects",
                  "vectors",
                  "logs",
                  "backups"
                ]
              },
              "dataClass": {
                "type": "string",
                "maxLength": 60
              },
              "rows": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991
              }
            },
            "required": [
              "store",
              "dataClass",
              "rows"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "file",
        "totalRows",
        "stores"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "dryRun": {
          "type": "boolean",
          "const": true
        },
        "service": {
          "type": "string"
        },
        "requests": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "method": {
                "type": "string"
              },
              "path": {
                "type": "string"
              },
              "body": {},
              "note": {
                "type": "string"
              }
            },
            "required": [
              "method",
              "path"
            ],
            "additionalProperties": false
          }
        },
        "commands": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "writes": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "path": {
                "type": "string"
              },
              "action": {
                "type": "string",
                "enum": [
                  "write",
                  "append",
                  "delete"
                ]
              },
              "description": {
                "type": "string"
              }
            },
            "required": [
              "path",
              "action",
              "description"
            ],
            "additionalProperties": false
          }
        },
        "notes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "dryRun",
        "requests",
        "commands",
        "writes",
        "notes"
      ],
      "additionalProperties": false
    }
  ]
}

See exit codes for the status the process returns.