aidp-cli

Oracle AI Data Platform

Oracle AI Data Platform simplifies cataloging, ingesting, and analyzing data for data professionals in an organization. The Oracle AI Data Platform service provides the platform and the framework to create data analytics pipelines.

Documentation

Oracle AI Data Platform documentation

Using CLI

Configure Auth

AIDP clients use OCI authentication. Configure an OCI profile before invoking the CLI or SDK.

Do not commit OCI configuration or private-key files. Store credentials in an approved secret-management solution. For CI/CD, prefer short-lived or federated authentication when available and grant only the permissions required for the operation.

oci setup config

For session-token authentication, authenticate with OCI CLI:

oci session authenticate \
  --profile-name DEFAULT \
  --region us-ashburn-1 \
  --tenancy-name <tenancy_name>

For API-key authentication, create an OCI config profile once if you do not already have one. OCI CLI can create the file for you if it is installed. Existing OCI config profiles can be reused.

Use the CLI

aidp --help
aidp command-groups
aidp workspace
aidp workspace list --help

#Invoke a workspace API:
aidp \
  --auth security_token \
  --profile DEFAULT \
  --region <oci_region> \
  --instance-id <ai_data_platform_ocid> \
  workspace list

AIDP CLI Command Refenece