datasphere-cli-capabilities.json

{
  "overview": {
    "description": "SAP Datasphere CLI provides command-line access to manage spaces, data, models, and integrations",
    "authentication": "OAuth2 with client credentials or interactive flow",
    "installation": "npm install -g @sap/datasphere-cli",
    "command_prefix": "datasphere"
  },
  "space_management": {
    "description": "Manage Datasphere spaces and their configurations",
    "commands": {
      "datasphere spaces read": {
        "description": "Read space configuration and metadata",
        "parameters": [
          "--space <space_name>"
        ],
        "example": "datasphere spaces read --space MY_SPACE",
        "api_equivalent": "/api/v1/spaces/{space_id}"
      },
      "datasphere spaces create": {
        "description": "Create a new space",
        "parameters": [
          "--space <space_name>",
          "--definition <file.json>"
        ],
        "example": "datasphere spaces create --space NEW_SPACE --definition space-config.json"
      },
      "datasphere spaces update": {
        "description": "Update space configuration",
        "parameters": [
          "--space <space_name>",
          "--definition <file.json>"
        ],
        "example": "datasphere spaces update --space MY_SPACE --definition updated-config.json"
      },
      "datasphere spaces delete": {
        "description": "Delete a space",
        "parameters": [
          "--space <space_name>"
        ],
        "example": "datasphere spaces delete --space OLD_SPACE"
      },
      "datasphere spaces list": {
        "description": "List all available spaces",
        "parameters": [],
        "example": "datasphere spaces list"
      }
    }
  },
  "data_integration": {
    "description": "Manage data flows, connections, and data integration tasks",
    "commands": {
      "datasphere dataflows read": {
        "description": "Read data flow definitions",
        "parameters": [
          "--space <space>",
          "--dataflow <name>"
        ],
        "example": "datasphere dataflows read --space MY_SPACE --dataflow ETL_FLOW"
      },
      "datasphere dataflows create": {
        "description": "Create new data flows",
        "parameters": [
          "--space <space>",
          "--definition <file.json>"
        ],
        "example": "datasphere dataflows create --space MY_SPACE --definition flow.json"
      },
      "datasphere dataflows deploy": {
        "description": "Deploy data flows",
        "parameters": [
          "--space <space>",
          "--dataflow <name>"
        ],
        "example": "datasphere dataflows deploy --space MY_SPACE --dataflow ETL_FLOW"
      },
      "datasphere connections read": {
        "description": "Read connection configurations",
        "parameters": [
          "--space <space>",
          "--connection <name>"
        ],
        "example": "datasphere connections read --space MY_SPACE --connection DB_CONN"
      },
      "datasphere connections create": {
        "description": "Create new connections",
        "parameters": [
          "--space <space>",
          "--definition <file.json>"
        ],
        "example": "datasphere connections create --space MY_SPACE --definition conn.json"
      }
    }
  },
  "data_modeling": {
    "description": "Manage data models, views, and analytical models",
    "commands": {
      "datasphere views read": {
        "description": "Read view definitions",
        "parameters": [
          "--space <space>",
          "--view <name>"
        ],
        "example": "datasphere views read --space MY_SPACE --view SALES_VIEW"
      },
      "datasphere views create": {
        "description": "Create new views",
        "parameters": [
          "--space <space>",
          "--definition <file.json>"
        ],
        "example": "datasphere views create --space MY_SPACE --definition view.json"
      },
      "datasphere views deploy": {
        "description": "Deploy views",
        "parameters": [
          "--space <space>",
          "--view <name>"
        ],
        "example": "datasphere views deploy --space MY_SPACE --view SALES_VIEW"
      },
      "datasphere tables read": {
        "description": "Read table definitions and data",
        "parameters": [
          "--space <space>",
          "--table <name>"
        ],
        "example": "datasphere tables read --space MY_SPACE --table CUSTOMER_DATA"
      },
      "datasphere tables create": {
        "description": "Create new tables",
        "parameters": [
          "--space <space>",
          "--definition <file.json>"
        ],
        "example": "datasphere tables create --space MY_SPACE --definition table.json"
      }
    }
  },
  "task_management": {
    "description": "Manage and monitor data integration tasks",
    "commands": {
      "datasphere tasks read": {
        "description": "Read task definitions and status",
        "parameters": [
          "--space <space>",
          "--task <name>"
        ],
        "example": "datasphere tasks read --space MY_SPACE --task DATA_LOAD_TASK"
      },
      "datasphere tasks create": {
        "description": "Create new tasks",
        "parameters": [
          "--space <space>",
          "--definition <file.json>"
        ],
        "example": "datasphere tasks create --space MY_SPACE --definition task.json"
      },
      "datasphere tasks run": {
        "description": "Execute tasks",
        "parameters": [
          "--space <space>",
          "--task <name>"
        ],
        "example": "datasphere tasks run --space MY_SPACE --task DATA_LOAD_TASK"
      },
      "datasphere tasks monitor": {
        "description": "Monitor task execution",
        "parameters": [
          "--space <space>",
          "--task <name>"
        ],
        "example": "datasphere tasks monitor --space MY_SPACE --task DATA_LOAD_TASK"
      }
    }
  },
  "marketplace": {
    "description": "Manage Data Marketplace content and packages",
    "commands": {
      "datasphere marketplace list": {
        "description": "List available marketplace packages",
        "parameters": [
          "--space <space>"
        ],
        "example": "datasphere marketplace list --space MY_SPACE"
      },
      "datasphere marketplace install": {
        "description": "Install marketplace packages",
        "parameters": [
          "--space <space>",
          "--package <name>"
        ],
        "example": "datasphere marketplace install --space MY_SPACE --package DATA_PACKAGE"
      },
      "datasphere marketplace publish": {
        "description": "Publish content to marketplace",
        "parameters": [
          "--space <space>",
          "--definition <file.json>"
        ],
        "example": "datasphere marketplace publish --space MY_SPACE --definition package.json"
      }
    }
  },
  "configuration": {
    "description": "CLI configuration and authentication management",
    "commands": {
      "datasphere login": {
        "description": "Authenticate with Datasphere tenant",
        "parameters": [
          "--client-id <id>",
          "--client-secret <secret>",
          "--host <url>"
        ],
        "example": "datasphere login --client-id abc123 --client-secret xyz789 --host https://tenant.eu10.hcs.cloud.sap"
      },
      "datasphere logout": {
        "description": "Log out from current session",
        "parameters": [
          "--login-id <id>"
        ],
        "example": "datasphere logout --login-id 0"
      },
      "datasphere config host set": {
        "description": "Set the target host/tenant",
        "parameters": [
          "<host_url>"
        ],
        "example": "datasphere config host set https://tenant.eu10.hcs.cloud.sap"
      },
      "datasphere config secrets show": {
        "description": "Show stored authentication secrets",
        "parameters": [],
        "example": "datasphere config secrets show"
      }
    }
  },
  "import_export": {
    "description": "Import and export Datasphere artifacts",
    "commands": {
      "datasphere import": {
        "description": "Import artifacts from files",
        "parameters": [
          "--space <space>",
          "--file <path>"
        ],
        "example": "datasphere import --space MY_SPACE --file artifacts.zip"
      },
      "datasphere export": {
        "description": "Export artifacts to files",
        "parameters": [
          "--space <space>",
          "--output <path>"
        ],
        "example": "datasphere export --space MY_SPACE --output backup.zip"
      }
    }
  }
}