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:
- CLI flag —
--api-url/--token - env —
AIPLATFORM_API_URL/AIPLATFORM_TOKEN - the selected profile (
--profile,AIPLATFORM_PROFILE, or the current one) - (URL only) the built-in default
http://127.0.0.1:8000
Config location override: AIPLATFORM_CONFIG_DIR.
Metadata
Release files for aiplatform-cli 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| aiplatform_cli-0.1.0.tar.gz | 10.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| aiplatform_cli-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 22.3 kB
Release files / aiplatform_cli-0.1.0.tar.gz
| Download URL | aiplatform_cli-0.1.0.tar.gz |
|---|---|
| Size | 10.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0f1ca639c65878e049e043ec51a23d7cf517ecebdf45280bb1439c37c406b342
|
|
BLAKE2b-256 checksum How to use checksums |
27c5f39e6d41d9e894a5489087611b6fa569f0bd756345cb5620ab6adddc1c40
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 27, 2026.
Transparency logRelease files / aiplatform_cli-0.1.0-py3-none-any.whl
| Download URL | aiplatform_cli-0.1.0-py3-none-any.whl |
|---|---|
| Size | 11.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5c3f53374de6b84998f12d5ee2f2987fcd35cca7d993bdb98d0b4cce187ffa2c
|
|
BLAKE2b-256 checksum How to use checksums |
9916cf8513b8a0a1308fcfff33bea5a85fd11fbcd0072fee0da09122fb974a70
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 27, 2026.
Transparency log