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
Ergonomics — offline shell completion, per-field filter flags + paging, pyVmomi fallback (perf/events/tasks/inventory) ✅ v0.3
Live resource-id completion 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.4.0.tar.gz (164.1 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.4.0-py3-none-any.whl (59.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vcf_super_cli-0.4.0.tar.gz
  • Upload date:
  • Size: 164.1 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.4.0.tar.gz
Algorithm Hash digest
SHA256 4deb823752925ee913b277a9d658f4b77fe068fca3ea07707587a58f3dd2a77d
MD5 c7875ee1fb7a475af30443ef4ca34161
BLAKE2b-256 4923448124d8a937ac9be4d5745d7b6b721d9b3a5abc1a1ef8b61306c9224cf8

See more details on using hashes here.

Provenance

The following attestation bundles were made for vcf_super_cli-0.4.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.4.0-py3-none-any.whl.

File metadata

  • Download URL: vcf_super_cli-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 59.6 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.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f5300e8465939eb51d5cfad9aef03c715f4bf4bfdb0af46a84bce88e7a285e84
MD5 0bd89ca8dd91d6fad4cf322e50c1640b
BLAKE2b-256 425c449390f002fa349f92974f09596de3c1e3f9cf3482bb1d7861cad12a7a47

See more details on using hashes here.

Provenance

The following attestation bundles were made for vcf_super_cli-0.4.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