Skip to main content

aiplatform-cli (aip)

A standalone, pure-HTTP control/ops CLI for an ai-platform deployment — in the spirit of gh / az / databricks. It talks to the platform only over its OpenAPI surface and imports zero platform internals (no ai_platform, no storage backends, no in-process domain import). So it installs and versions independently of the server:

pipx install aiplatform-cli

This is issue #49: a deploy/ops tool should depend on the API contract, not the API's source. (The TS SDK already does this for the read path; this is the same philosophy for the write/ops path.)

The deploy split

A pure-HTTP tool can't introspect a domain's JobDefinition / ArtifactType schemas. That one step lives in the domain's venv (which has aiplatform-core + the domain installed) and emits a plain-JSON catalog:

# domain-side build (ships in aiplatform-core)
aiplatform export-manifest --bundle bundle.toml -o catalog.json

The CLI then replays that catalog over HTTP — no domain import:

aip login --api-url https://my-platform:8000
aip deploy --catalog catalog.json            # uploads wheel + POSTs catalog

Commands

Command What it does
aip login --api-url URL [--token T] [--profile P] Save a profile to ~/.config/aiplatform/config.json
aip deploy --catalog catalog.json [--wheel W] [--skip-wheel] Upload wheel + POST job-definitions / artifact-types / prompts
aip job-definitions List registered job definitions
aip artifact-types List registered artifact types
aip jobs [--status S] [--job-type T] List jobs
aip cancel JOB_ID Cancel / reclaim a job (POST /jobs/{id}/cancel)
aip snapshot-openapi [--out PATH] Dump /openapi.json for the SDK-regen workflow

Connection resolution

For every command, the API URL and token resolve in this order:

  1. CLI flag — --api-url / --token
  2. env — AIPLATFORM_API_URL / AIPLATFORM_TOKEN
  3. the selected profile (--profile, AIPLATFORM_PROFILE, or the current one)
  4. (URL only) the built-in default http://127.0.0.1:8000

Config location override: AIPLATFORM_CONFIG_DIR.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aiplatform_cli-0.1.0.tar.gz (10.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aiplatform_cli-0.1.0-py3-none-any.whl (11.8 kB view details)

Uploaded Python 3

File details

Details for the file aiplatform_cli-0.1.0.tar.gz.

File metadata

  • Download URL: aiplatform_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 10.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for aiplatform_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 0f1ca639c65878e049e043ec51a23d7cf517ecebdf45280bb1439c37c406b342
MD5 e22bd7c51801eb67f5142d9502ead235
BLAKE2b-256 27c5f39e6d41d9e894a5489087611b6fa569f0bd756345cb5620ab6adddc1c40

See more details on using hashes here.

Provenance

The following attestation bundles were made for aiplatform_cli-0.1.0.tar.gz:

Publisher: pypi-publish-cli.yml on sepoul/ai-platform

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file aiplatform_cli-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: aiplatform_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 11.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for aiplatform_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5c3f53374de6b84998f12d5ee2f2987fcd35cca7d993bdb98d0b4cce187ffa2c
MD5 7a841369ccb00e17c5687b3f88bbf569
BLAKE2b-256 9916cf8513b8a0a1308fcfff33bea5a85fd11fbcd0072fee0da09122fb974a70

See more details on using hashes here.

Provenance

The following attestation bundles were made for aiplatform_cli-0.1.0-py3-none-any.whl:

Publisher: pypi-publish-cli.yml on sepoul/ai-platform

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page