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.3.0.tar.gz (153.7 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.3.0-py3-none-any.whl (53.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vcf_super_cli-0.3.0.tar.gz
  • Upload date:
  • Size: 153.7 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.3.0.tar.gz
Algorithm Hash digest
SHA256 cb24811cf35de5a585f15b65b4a73fe25b8463f1a5fbb9f3c449ff884b2849ff
MD5 8c2061ee56d99df6b254af397295d0af
BLAKE2b-256 55e7f06f7d216b89f0fb6cb5ecc5763eceac2d98a9b34b9bc13bb4a5e73e4065

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: vcf_super_cli-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 53.1 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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1b47a798429f22ac3a50ceeb0c179b1aedf38ad77ab4b750cb51f2b2fe825756
MD5 058f7294e475a5d9be85235bc9e43975
BLAKE2b-256 b83fc9de3ede7e901faf55dd16556e3b3786a44743d766d4e49d0098e5158824

See more details on using hashes here.

Provenance

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