AIDP Deploy — VS Code Extension

Browse Oracle AIDP workspaces and master catalog, upload files, and manage agent flow deployments — all from VS Code.

Workspace Browser

Navigates the workspace file system using a single recursive API:

GET /workspaces/{id}/objects?path={path}

Root → folders → subfolders → files/notebooks
Right-click any node to copy the remote path or open in the AIDP console

Master Catalog Browser

Navigates the full catalog hierarchy:

catalogs → schemas → tables + volumes → volume files

APIs used: | Endpoint | Purpose | |---|---| | GET .../catalogs | List all catalogs | | GET .../schemas?catalogKey= | Schemas in a catalog | | GET .../tables?catalogKey=&schemaKey= | Tables in a schema | | GET .../volumes?catalogKey=&schemaKey= | Volumes (storage buckets) | | GET .../volumes/{key}/files?path= | Files inside a volume |

Upload & Deploy

Feature	Description
Upload All (`Cmd+Shift+Alt+U`)	Push every file in `aidp-deploy.config.json`
Upload Current (`Cmd+Shift+U`)	Upload the active editor file
Right-click Upload	Explorer context menu on mapped files
Upload on Save	Opt-in auto-upload on save
Deploy / Redeploy / Undeploy	Full agent flow lifecycle
Status Bar	Live agent flow state (polls every 30s)

Upload protocol (reverse-engineered):

POST .../actions/uploadFileMeta → get Pre-Authenticated Request URL
PUT {parUrl} → upload raw bytes to Object Storage

Prerequisites

Node.js ≥ 18
oci-common SDK
OCI config + API signing key at {workspace}/.oci/config
aidp-deploy.config.json in your workspace root

Config File

{
  "region": "us-chicago-1",
  "apiVersion": "20240831",
  "dataLakeOcid": "ocid1.aidataplatform.oc1...",
  "workspaceId": "18e99de5-3413-49a7-b47d-cebaa6b2c74f",
  "agentFlow": {
    "key": "af-key",
    "computeKey": "compute-key",
    "displayName": "My Agent Flow"
  },
  "files": [
    {
      "localPath": "src/agent.py",
      "remotePath": "/agents/agent.py"
    }
  ]
}

API Base URL Pattern

All APIs follow this structure:

https://aidp.{region}.oci.oraclecloud.com/{apiVersion}/dataLakes/{dataLakeOcid}/...

Workspace-scoped endpoints add:

.../workspaces/{workspaceId}/...

Settings

Setting	Default	Description
`aidp.uploadOnSave`	`false`	Auto-upload mapped files on save
`aidp.statusBarPollingInterval`	`30`	Seconds between polls (0 = off)
`aidp.showNotifications`	`true`	Toast notifications
`aidp.ociConfigPath`	`""`	Override OCI config path

Development

npm install
npm run watch
# Press F5 to launch Extension Host

Packaging & Publishing

npm run compile
npx vsce package   # → aidp-deploy-x.x.x.vsix (local package only)

Release to both VS Code Marketplace and Open VSX

npm run release            # bump patch (0.2.5 → 0.2.6) and publish to both
npm run release -- minor   # bump minor (0.2.5 → 0.3.0)
npm run release -- major   # bump major (0.2.5 → 1.0.0)

This compiles, packages, publishes to both registries, and cleans up.

One-time setup

npx vsce login jacques-vigeant          # paste Azure DevOps PAT
export OVSX_PAT=<your-open-vsx-token>   # or set in .env / shell profile

AIDP Deploy

Jacques-Vigeant