vcf-super-cli 0.2.0__tar.gz

vcf_super_cli-0.2.0/.github/workflows/docs.yml

@@ -0,0 +1,46 @@
+name: docs
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: docs-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - name: Sync (docs)
+        run: uv sync --group docs
+      - name: Build site
+        run: uv run mkdocs build --strict
+      - name: Upload pages artifact
+        if: github.ref == 'refs/heads/main'
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+
+  deploy:
+    if: github.ref == 'refs/heads/main'
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

vcf_super_cli-0.2.0/.github/workflows/e2e.yml

@@ -0,0 +1,31 @@
+name: e2e
+
+# Live tests against a real vCenter/NSX. Manual only; reads connection details
+# from repository secrets. Individual tests self-skip when their backend's
+# secrets are not configured.
+on:
+  workflow_dispatch:
+
+jobs:
+  e2e:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - name: Sync (dev)
+        run: uv sync --group dev
+      - name: Run e2e
+        env:
+          VSC_E2E: "1"
+          VSC_VSPHERE_SERVER: ${{ secrets.VSC_VSPHERE_SERVER }}
+          VSC_VSPHERE_USERNAME: ${{ secrets.VSC_VSPHERE_USERNAME }}
+          VSC_VSPHERE_PASSWORD: ${{ secrets.VSC_VSPHERE_PASSWORD }}
+          VSC_VSPHERE_INSECURE: ${{ secrets.VSC_VSPHERE_INSECURE }}
+          VSC_NSX_SERVER: ${{ secrets.VSC_NSX_SERVER }}
+          VSC_NSX_USERNAME: ${{ secrets.VSC_NSX_USERNAME }}
+          VSC_NSX_PASSWORD: ${{ secrets.VSC_NSX_PASSWORD }}
+          VSC_NSX_INSECURE: ${{ secrets.VSC_NSX_INSECURE }}
+        run: uv run pytest tests/e2e -v

vcf_super_cli-0.2.0/.github/workflows/lint.yml

@@ -0,0 +1,28 @@
+name: lint
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+concurrency:
+  group: lint-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - name: Sync (dev)
+        run: uv sync --group dev
+      - name: Ruff (lint)
+        run: uv run ruff check .
+      - name: Ruff (format check)
+        run: uv run ruff format --check .
+      - name: mypy
+        run: uv run mypy vsc

vcf_super_cli-0.2.0/.github/workflows/release.yml

@@ -0,0 +1,120 @@
+name: release
+
+# Tag-only trigger. NEVER on pull_request or branch push — the trusted
+# publisher is bound to this workflow filename + the v* tag pattern.
+on:
+  push:
+    tags:
+      - "v[0-9]*.[0-9]*.[0-9]*"
+
+# Trusted publishing requires id-token: write so the OIDC token issued to
+# pypa/gh-action-pypi-publish is signed.
+permissions:
+  contents: write   # gh release create
+  id-token: write   # PyPI trusted publishing OIDC
+
+concurrency:
+  group: release
+  cancel-in-progress: false
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    # No `environment:` block — the PyPI trusted publisher for this project is
+    # registered with a blank Environment, so the OIDC subject must NOT carry one.
+    # Adding an `environment:` here changes the subject claim and breaks the match.
+    steps:
+      - name: Checkout (full history for changelog notes)
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Verify tag is on main
+        run: |
+          set -euo pipefail
+          git fetch origin main
+          if ! git merge-base --is-ancestor "$GITHUB_SHA" origin/main; then
+            echo "Tag $GITHUB_REF_NAME points at $GITHUB_SHA which is not reachable from main." >&2
+            exit 1
+          fi
+          echo "Tag $GITHUB_REF_NAME ($GITHUB_SHA) is on main."
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+
+      - name: Install Python
+        run: uv python install 3.12
+
+      - name: Sync runtime deps (so the next step can import vsc._version)
+        run: uv sync --frozen
+
+      - name: Verify tag matches package version
+        run: |
+          set -euo pipefail
+          tag_version="${GITHUB_REF_NAME#v}"
+          pkg_version="$(uv run python -c 'from vsc._version import __version__; print(__version__)')"
+          if [ "$tag_version" != "$pkg_version" ]; then
+            echo "Tag $GITHUB_REF_NAME -> $tag_version does not match vsc/_version.py $pkg_version" >&2
+            exit 1
+          fi
+          echo "Tag $GITHUB_REF_NAME matches package version $pkg_version"
+
+      - name: Build sdist + wheel
+        run: |
+          rm -rf dist
+          uv build --out-dir dist
+          ls -la dist/
+
+      - name: Verify wheel + sdist filenames match tag
+        run: |
+          set -euo pipefail
+          tag_version="${GITHUB_REF_NAME#v}"
+          if ! ls "dist/vcf_super_cli-${tag_version}-py3-none-any.whl" >/dev/null 2>&1; then
+            echo "Wheel for ${tag_version} not found in dist/" >&2; ls dist/ >&2; exit 1
+          fi
+          if ! ls "dist/vcf_super_cli-${tag_version}.tar.gz" >/dev/null 2>&1; then
+            echo "Sdist for ${tag_version} not found in dist/" >&2; ls dist/ >&2; exit 1
+          fi
+
+      - name: Publish to PyPI (trusted publishing)
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist
+          verbose: true
+          skip-existing: true
+
+      - name: Extract changelog section for release notes
+        run: |
+          set -euo pipefail
+          tag_version="${GITHUB_REF_NAME#v}"
+          awk -v ver="$tag_version" '
+            $0 ~ "^## v" ver " " { capture=1; print; next }
+            capture && /^## / { exit }
+            capture { print }
+          ' CHANGELOG.md > /tmp/release-notes.md
+          if [ ! -s /tmp/release-notes.md ]; then
+            echo "Release notes for v${tag_version} not found in CHANGELOG.md" >&2
+            exit 1
+          fi
+
+      - name: Create GitHub Release
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          set -euo pipefail
+          tag_version="${GITHUB_REF_NAME#v}"
+          whl="dist/vcf_super_cli-${tag_version}-py3-none-any.whl"
+          sdist="dist/vcf_super_cli-${tag_version}.tar.gz"
+          # Idempotent: PyPI publish above is skip-existing, so a re-run must not
+          # hard-fail here just because the GitHub Release already exists.
+          if gh release view "$GITHUB_REF_NAME" >/dev/null 2>&1; then
+            gh release edit "$GITHUB_REF_NAME" \
+              --title "$GITHUB_REF_NAME" --notes-file /tmp/release-notes.md
+            gh release upload "$GITHUB_REF_NAME" "$whl" "$sdist" --clobber
+          else
+            gh release create "$GITHUB_REF_NAME" \
+              --title "$GITHUB_REF_NAME" --notes-file /tmp/release-notes.md \
+              "$whl" "$sdist"
+          fi

vcf_super_cli-0.2.0/.github/workflows/test.yml

@@ -0,0 +1,30 @@
+name: test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+concurrency:
+  group: test-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+      - name: Sync (dev)
+        run: uv sync --group dev
+      - name: Run tests
+        run: uv run --python ${{ matrix.python-version }} pytest --cov=vsc --cov-report=term-missing

vcf_super_cli-0.2.0/.gitignore

@@ -0,0 +1,34 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+.installed.cfg
+
+# Virtualenv / uv
+.venv/
+venv/
+.python-version
+
+# Tooling caches
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+.coverage
+coverage.xml
+htmlcov/
+
+# Docs build
+site/
+
+# Local config / secrets
+*.local
+.env
+profiles.local.*
+
+# Editors / OS
+.idea/
+.vscode/
+.DS_Store

vcf_super_cli-0.2.0/AGENTS.md

@@ -0,0 +1,37 @@
+# AGENTS.md
+
+Guidance for AI agents and contributors working in this repo.
+
+## What this is
+
+`vcf-super-cli` (`vsc`) — a CLI for VMware Cloud Foundation 9. The command tree is
+**generated** by introspecting the `vcf-sdk` vAPI bindings (`vsc.gen`), not hand
+written. Two product groups: `vsc vsphere …` (vCenter) and `vsc nsx …` (NSX Policy).
+
+## Project conventions
+
+- Python ≥3.12. Managed with **uv**. Build backend: hatchling.
+- Lint/format: **ruff** (`uv run ruff check .`, `uv run ruff format .`).
+- Types: **mypy --strict** (`uv run mypy vsc`).
+- Tests: **pytest** (`uv run pytest`). Live-server tests live in `tests/e2e/`
+  and are ignored by default.
+- Output is JSON by default; errors use a stable envelope; exit codes are a frozen
+  `IntEnum` in `vsc/output/exit_codes.py` — extend, never renumber.
+- v0.1 is **read-only**. Writes (v0.2) must be dry-run by default, gated on `--apply`.
+
+## Workflow
+
+Work is **issue-driven**. One issue → one branch → PR → review → fix → merge.
+Do not push directly to `main`. See open issues for the roadmap.
+
+## Where things go
+
+| Concern | Location |
+|---------|----------|
+| Entry point / Typer app | `vsc/cli/` |
+| SDK introspection + command generation | `vsc/gen/` |
+| Connections / auth | `vsc/connect/` |
+| Profiles / config | `vsc/config/` |
+| Output, errors, exit codes | `vsc/output/` |
+| Bundled agent Skill | `vsc/skill/assets/SKILL.md` (export via `vsc skill export`) |
+| Design spec | `docs/superpowers/specs/` |

vcf_super_cli-0.2.0/CHANGELOG.md

@@ -0,0 +1,60 @@
+# Changelog
+
+All notable changes to `vcf-super-cli` are documented here. The format is based
+on [Keep a Changelog](https://keepachangelog.com/), and from v1.0.0 the project
+will follow [Semantic Versioning](https://semver.org/). While on `0.x`, minor
+versions may include breaking changes.
+
+## [Unreleased]
+
+## v0.2.0 — 2026-06-05
+
+First PyPI release. Adds the **write** surface on top of the v0.1 read-only
+foundation, with a dry-run-by-default safety model.
+
+### Added
+
+- **Write operations** (`POST`/`PUT`/`PATCH`/`DELETE`) are generated from the
+  `vcf-sdk` vAPI metadata alongside reads (#20). Clean, collision-free verbs:
+  `POST ?action=X` → `X`; otherwise `PUT` → `set`, `PATCH` → `patch`,
+  `DELETE` → `delete` (force variants prefixed `force-`); `POST` without an
+  action keeps its operation id.
+- **Dry-run by default + `--apply`** (#21). Every write previews the resolved
+  request and changes nothing — and opens **no connection** — unless `--apply`
+  is passed. `--apply` is the only gate (no interactive prompt), so the CLI
+  stays fully scriptable. New `vsc/gen/preview.py` builds the request plan.
+- **Stable write envelope**, identical across modes — branch on `applied`:
+  - dry-run: `{ "applied": false, "request": { method, url, path_params, query, body, … }, "apply_hint": … }`
+  - applied: `{ "applied": true, "request": { … }, "result": <sdk response> }`
+- **Body/spec construction from JSON** for both conventions: NSX's named request
+  body and vCenter's spec parameters, built into the SDK binding structs.
+- **Catalog expansion**: vSphere `resource-pool` and the VM power/hardware leaves
+  (`power`, `cpu`, `memory`, `disk`, `ethernet`); NSX `ip-pools`,
+  `dhcp-server-configs`, `dhcp-relay-configs`, and Tier-1 `locale-services`.
+- **`CONFLICT` (7) / `UNAVAILABLE` (8)** exit-code coverage for write errors
+  (#22), derived from the error-type map so it can't drift.
+
+### Changed
+
+- A malformed or incomplete write body is reported during the dry-run as the
+  structured usage envelope (exit `2`) — before any connection — not as a
+  traceback.
+- Documentation and the bundled agent `SKILL.md` describe the write surface and
+  the `--apply` safety model (#23).
+
+## v0.1.0 — 2026-06-05
+
+Initial read-only foundation (not published to PyPI).
+
+### Added
+
+- Command tree **generated dynamically** by introspecting the installed `vcf-sdk`
+  vAPI bindings (`VapiInterface` services + `OperationRestMetadata`), fully
+  offline — `--help` works without a server or credentials.
+- Read (`GET`) commands for vSphere/vCenter (`vsc vsphere …`) and NSX Policy
+  (`vsc nsx …`), split into two product groups.
+- Named **profiles** with env-var overrides and optional OS-keyring secret
+  storage; `--profile/-p` selection.
+- **Output contract**: JSON by default, `--output table` for humans; a stable
+  error envelope on stderr and documented, frozen **exit codes**.
+- Bundled agent **Skill** shipped in the wheel, exportable via `vsc skill export`.

vcf_super_cli-0.2.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.