Skip to main content

Packaged SVC corpus and local development-collaboration CLI.

Project description

Sustainable Vibe Coding

Sustainable Vibe Coding (SVC) is a source-first framework delivered as a versioned local corpus and a small development-collaboration CLI. It helps AI-assisted teams retain costly-to-rediscover truth without copying upstream framework documents into every repository.

Develop SVC

Requirements: Python 3.11+ and PDM.

pdm install
pdm run test
pdm run build-monolith
pdm run svc --help
pdm build

Edit canonical framework content under src/, never build/monolith.md. src/ contains only SVC corpus content and release metadata; Python runtime code is in svc_cli/, and repository-only builders/release tools are in tools/.

Use a Released Corpus

Install the CLI, then query the guidance you need. The wheel contains the read-only corpus and a deterministic catalog, so ordinary lookup writes nothing and contacts no service.

python -m pip install sustainable-vibe-coding==10.0.0

svc lookup --name 'sections/working-protocol\.md'
svc lookup --name 'assets/templates/AGENTS\..*\.template\.md' --all
svc lookup --keyword "task packet mutation gate"

--name is a full-path regular expression over source-relative SVC document paths—not a document ID. Keyword results are short, deterministic candidates; use a returned path with --name to read canonical content. Semantic search is intentionally deferred until a local artifact and quality contract are measured.

Initialize a Consumer Project

Initialization is dry-run by default. It creates no copied SVC documents and never silently overwrites consumer content.

svc init /path/to/project --agent codex --json
svc init /path/to/project --apply <plan-digest>
svc status /path/to/project

The exact-plan apply may create:

svc.json
.agents/skills/svc/SKILL.md
AGENTS.md                  (a bounded generated SVC navigation block)
docs/index.md              (created when absent, with a bounded generated navigation block)

svc.json records only the project's adopted SVC baseline (plus its file schema):

{
  "schema_version": 1,
  "svc_version": "10.0.0"
}

Everything unmarked in AGENTS.md and docs/index.md remains Consumer-owned. The Codex skill is a substantial operational guide to svc commands, not a duplicate of the framework corpus. Modified generated blocks or skills block refresh for human review.

Upgrade Deliberately

The executable and project adoption are deliberately separate:

svc self-update --json
svc self-update --apply <plan-digest>

svc status /path/to/project
svc lookup --keyword "migration"
svc adopt 10.0.0 /path/to/project --apply <plan-digest>

self-update changes only a supported non-editable pip installation in the current interpreter. It never changes svc.json. After reviewing any packaged migration guidance and applying Consumer-owned changes under the project's mutation gate, svc adopt records the new baseline in svc.json through another exact plan.

Behavioral SemVer and Releases

SVC uses Behavioral SemVer:

  • MAJOR changes required obligations, defaults, permission/authority boundaries, task-packet semantics, consumer layout, or a stable CLI/catalog contract.
  • MINOR adds an optional backward-compatible capability.
  • PATCH fixes or clarifies the existing protocol without changing those behaviors.

Towncrier fragments and the release planner make the impact reviewable. GitHub Releases are the canonical release record; the Python package is the installation projection. See CONTRIBUTING.md for commit, fragment, and release workflow rules.

Repository Layout

src/                         canonical SVC corpus and release metadata
svc_cli/                     installable Python runtime
tools/                       catalog, monolith, and release tooling
pdm_build.py                 wheel corpus projection hook
tests/                       contract and fixture tests
tasks/                       volatile work packets

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

sustainable_vibe_coding-10.0.0.tar.gz (51.1 kB view details)

Uploaded Source

Built Distribution

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

sustainable_vibe_coding-10.0.0-py3-none-any.whl (44.6 kB view details)

Uploaded Python 3

File details

Details for the file sustainable_vibe_coding-10.0.0.tar.gz.

File metadata

  • Download URL: sustainable_vibe_coding-10.0.0.tar.gz
  • Upload date:
  • Size: 51.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for sustainable_vibe_coding-10.0.0.tar.gz
Algorithm Hash digest
SHA256 03918f093545971cd1a8f30d5f82723bb52c8c8128596d108f23c290c391749f
MD5 1b66b2131eba0a5c955b6b890668a800
BLAKE2b-256 af25ed957eaa8a2d97beb58541aef8f2b2d7eedbe8b2952c2e33d40afb244dca

See more details on using hashes here.

Provenance

The following attestation bundles were made for sustainable_vibe_coding-10.0.0.tar.gz:

Publisher: publish.yml on xiaoland/svc

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

File details

Details for the file sustainable_vibe_coding-10.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for sustainable_vibe_coding-10.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 112940b0a423988711adf1325f33dd2f99609af17327aee843bc1226357d9053
MD5 8ac6f008bd6fbab644ed420e6a29b9bb
BLAKE2b-256 7a0949fcad950ab9f96da67dde44b74b4b66d5c29b3532a94f057a4d8a3e5504

See more details on using hashes here.

Provenance

The following attestation bundles were made for sustainable_vibe_coding-10.0.0-py3-none-any.whl:

Publisher: publish.yml on xiaoland/svc

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