Skip to main content

Modern, agent-friendly CLI for VMware Cloud Foundation 9, with a command tree generated dynamically from the vcf-sdk vAPI bindings.

Project description

vcf-super-cli (vsc)

PyPI CI Lint Docs License

A modern, agent-friendly CLI for VMware Cloud Foundation 9. The command tree is generated dynamically by introspecting the official vcf-sdk vAPI bindings — so the surface mirrors the real VCF 9 API instead of being hand-maintained.

$ vsc vsphere vm list --profile prod
$ vsc vsphere host get --host host-42
$ vsc nsx segments list --output table
$ vsc vsphere power stop vm-42 --apply        # writes are dry-run without --apply

⚠️ Alpha / pre-release. Reads (vSphere + NSX inventory) and writes are both available. Writes are dry-run by default — nothing changes without --apply, and a dry-run never opens a connection.

Why

  • Mirrors the real API. Commands come from the SDK's own vAPI metadata (VapiInterface services + OperationRestMetadata), covering both vCenter and NSX from one generator.
  • Modern. REST-first via vmware-vcenter, with pyVmomi as a fallback where REST lacks coverage.
  • Safe by default. Writes preview as dry-runs unless you pass --apply; a dry-run never opens a connection.
  • Agent-friendly. Deterministic command shape, machine-readable JSON output, a stable error envelope with documented exit codes, and a bundled agent Skill.

Scope

Area Status
vSphere / vCenter read (vsc vsphere …) ✅ v0.1
NSX Policy API read (vsc nsx …) ✅ v0.1
Writes — dry-run by default + --apply (vsc vsphere … / vsc nsx …) ✅ v0.2
Dynamic shell completion, per-field filter flags, pyVmomi fallback v0.3 (planned)
NSX Manager / Global-Manager, SDDC Manager, Operations, LCM deferred

Install

uv tool install vcf-super-cli      # recommended
# or
pipx install vcf-super-cli
# or
pip install vcf-super-cli

From source:

uv sync && uv run vsc --help

Documentation

Full guide: thomaschristory.github.io/vcf-super-cli

License

Apache-2.0. See LICENSE.

Project details


Download files

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

Source Distribution

vcf_super_cli-0.2.0.tar.gz (129.3 kB view details)

Uploaded Source

Built Distribution

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

vcf_super_cli-0.2.0-py3-none-any.whl (37.7 kB view details)

Uploaded Python 3

File details

Details for the file vcf_super_cli-0.2.0.tar.gz.

File metadata

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

File hashes

Hashes for vcf_super_cli-0.2.0.tar.gz
Algorithm Hash digest
SHA256 090df4ef24c45201a00e6ec7e9c3d4e917bf24fa6eccc8f898a7883e06f94c80
MD5 a71a0c3779af67e850a076975e2c843d
BLAKE2b-256 e2b5a9db2796aed3f72e2a6c8a826402107e8c3b0b38be470d05177a06d64a31

See more details on using hashes here.

Provenance

The following attestation bundles were made for vcf_super_cli-0.2.0.tar.gz:

Publisher: release.yml on thomaschristory/vcf-super-cli

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

File details

Details for the file vcf_super_cli-0.2.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for vcf_super_cli-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8ed919044cc7c6b1bf209fb4b61711191f01960b0dbccdcd35f6b7e49a2f244b
MD5 08c380ca9a194748322cab29ab21f03f
BLAKE2b-256 3c0f06413cee33e8d94cf0752c792d71cc6df2a508a569805c590a3ea317d2a0

See more details on using hashes here.

Provenance

The following attestation bundles were made for vcf_super_cli-0.2.0-py3-none-any.whl:

Publisher: release.yml on thomaschristory/vcf-super-cli

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

Supported by

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