vbash 0.1.0__tar.gz → 0.2.0__tar.gz

vbash-0.2.0/.env.example

@@ -0,0 +1,11 @@
+# Copy to .env and fill in your values.
+MODEL_NAME=openrouter:anthropic/claude-sonnet-4
+OPENROUTER_API_KEY=sk-or-your-key-here
+
+# Optional vsh persistence
+# VSH_DATA_DIR=~/.vsh
+# VSH_PERSIST=1
+
+# Optional CodeMode MCP custom instructions
+# VSH_CODEMODE_INSTRUCTIONS=Prefer vsh_rg over vsh_grep.
+# VSH_CODEMODE_INSTRUCTIONS_FILE=.vsh/codemode-instructions.md

vbash-0.2.0/.github/workflows/publish.yml

@@ -0,0 +1,38 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - v*
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    name: Build and publish
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/vbash/
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+
+      - name: Install Python
+        run: uv python install 3.12
+
+      - name: Build distributions
+        run: uv build
+
+      - name: Publish to PyPI
+        run: uv publish

vbash-0.2.0/.gitignore

@@ -0,0 +1,37 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+dist/
+build/
+.eggs/
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+
+# Tooling
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.ty_cache/
+.coverage
+htmlcov/
+.hypothesis/
+
+# Editors / OS
+.DS_Store
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# Local env
+.env
+.env.*
+!.env.example
+
+# Playground benchmark artifacts
+playground/reports/2026*

vbash-0.2.0/CHANGELOG.md

@@ -0,0 +1,62 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+## [Unreleased]
+
+### Added
+
+- Protected workspace path policy (`VSH_PROTECTED_PATTERNS`, `VSH_PROTECTED_PATTERNS_FILE`)
+- Approval tiers on `SimulationResult` (`read_only`, `mutation`, `destructive`)
+- `auto_approve_plan()` for read-only auto-approval; `approve_plan(..., auto=True)`
+- Read command stdout capture in `ActualEffects.stdout` (`vsh.execute.read_output`)
+- Execution timing fields: `simulation_time_ms`, `execution_time_ms`, `total_time_ms`
+- `VSH_MAX_TOUCHED_PATHS` simulation limit (default `500`)
+- Shell previews quote paths with `shlex.quote`
+
+### Fixed
+
+- `vsh_list` now rejects workspace escapes (`/`, `..`, paths outside the root) during simulation
+- Execution layer enforces workspace boundaries via `ExecutionContext.resolve_within_workspace`
+
+## [0.2.0] - 2026-06-08
+
+### Added
+
+- CodeMode FastMCP server (`vsh serve-codemode`, `vsh-codemode`) with workflow prompts
+- CodeMode custom instructions via CLI (`-i`, `-f`), env vars, and `create_codemode_server(custom_instructions=...)`
+- Real filesystem executor (`vsh.execute.apply_command`, `execute_approved`)
+- Pre-execution drift detection via path fingerprints (`vsh.execute.revalidate_plan`)
+- Plan fingerprints and touched-path basis on every simulation
+- Optional JSON persistence (`VSH_DATA_DIR`, `VSH_PERSIST`)
+- Extension hook registry for hydration, semantic analyzers, shadow workspaces
+- `vsh_sort` command
+- Gemini-safe inlined JSON schemas (`inline_json_schema`)
+- Documentation: `docs/ARCHITECTURE.md`, `docs/API.md`, `docs/CODEMODE.md`
+
+### Changed
+
+- `shell_preview` now uses `command.to_shell()` instead of `repr(command)`
+- `approve_with_warning` plans are execution-eligible (still gated by raw shell match)
+- `ExecutionResult` includes `revalidation`, `actual_effects`, `matches_prediction`
+- Snapshot builder ignores `.venv`, `node_modules`, `dist`, `build`, `target`
+- Version bumped to `0.2.0` (23 commands)
+
+### Fixed
+
+- pydantic-ai / Gemini tool schema failures from `$defs/SideEffect` references
+
+## [0.1.0] - 2026-06-08
+
+First public v0 release.
+
+### Added
+
+- Typed command registry with JSON schema export for workspace commands
+- `StructuredCommand` models with canonical shell previews and side-effect metadata
+- Workspace snapshot graph builder with protected-root policy
+- Simulation engine with approve / reject / warn decisions
+- Plan store, approval tokens, and execution eligibility checks
+- FastMCP server exposing search, schema, snapshot, simulate, approve, and execute tools
+- CLI: `vsh search`, `vsh schema`, `vsh names`, `vsh serve`
+- pydantic-ai `FunctionToolset` integration (`vsh.agent`)

vbash-0.2.0/LICENSE

@@ -0,0 +1,190 @@
+                                 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
+
+   Copyright 2026 vsh contributors
+
+   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.

vbash-0.2.0/PKG-INFO

@@ -0,0 +1,161 @@
+Metadata-Version: 2.4
+Name: vbash
+Version: 0.2.0
+Summary: vsh is a validation-first command engine for agent workspaces.
+License: Apache-2.0
+License-File: LICENSE
+Keywords: agents,commands,mcp,simulation,workspaces
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.11
+Requires-Dist: click>=8.1.8
+Requires-Dist: dotenv>=0.9.9
+Requires-Dist: fastmcp>=2.0
+Requires-Dist: pydantic>=2.7
+Requires-Dist: python-dotenv>=1.2.2
+Provides-Extra: agent
+Requires-Dist: pydantic-ai>=0.2; extra == 'agent'
+Provides-Extra: dev
+Requires-Dist: basedpyright; extra == 'dev'
+Requires-Dist: matplotlib; extra == 'dev'
+Requires-Dist: pydantic-ai>=0.2; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: ty; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# vsh
+
+Validation-first command engine for AI agents operating on workspaces.
+
+`vsh` is not a POSIX shell emulator. It is a **safe command planning and execution control layer** for AI agents: shell-like intent becomes typed `StructuredCommand` models, side effects are simulated on a workspace snapshot, plans are approved, drift is revalidated, and only then are mutations applied to the real filesystem. Read commands validate path access and return captured stdout on execution; simulation does not stream file contents.
+
+## Install
+
+```bash
+uv sync
+```
+
+`uv sync` installs the project plus `dev` and `agent` dependency groups (including `pydantic-ai`).
+
+For pip-only workflows:
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev,agent]"
+```
+
+## Quick start
+
+```bash
+vsh search ls
+vsh schema vsh_list
+vsh serve
+```
+
+## End-to-end lifecycle
+
+```python
+from vsh import LsCommand
+from vsh.execute import execute_approved
+from vsh.plans import approve_plan
+from vsh.simulate.engine import simulate_command
+from vsh.snapshot.builder import snapshot_workspace
+
+workspace = "/path/to/project"
+snapshot = snapshot_workspace(workspace, cwd=workspace)
+result = simulate_command(LsCommand(path=".", all=True), snapshot)
+token = approve_plan(result.plan_id)
+execution = execute_approved(token.token)
+
+print(execution.applied, execution.matches_prediction)
+```
+
+Flow: **search → get_schema → snapshot → simulate → approve → execute_approved**
+
+## Documentation
+
+- [Architecture](docs/ARCHITECTURE.md) — modules, lifecycle, drift detection, persistence
+- [API reference](docs/API.md) — public Python/MCP surface
+- [CodeMode MCP server](docs/CODEMODE.md) — discovery-first FastMCP server and prompts
+
+## MCP
+
+`vsh serve` starts the default FastMCP server.
+
+For **CodeMode-style discovery** (search → schema on demand → simulate → approve → execute), use the dedicated server:
+
+```bash
+vsh serve-codemode
+# or
+vsh-codemode
+```
+
+See [docs/CODEMODE.md](docs/CODEMODE.md) for the CodeMode inspiration, prompts, and client config examples.
+
+Both servers expose the same compact tool surface:
+
+- tools: `search`, `get_schema`, `snapshot_workspace`, `simulate`, `approve`, `execute_approved`
+- resources: workspace snapshot/projection, command spec cards, simulation records
+
+## pydantic-ai agent
+
+```bash
+cp .env.example .env
+# fill in MODEL_NAME and OPENROUTER_API_KEY
+
+uv run python examples/pydantic_ai_agent_demo.py --mode live
+```
+
+```python
+from pydantic_ai import Agent
+from vsh.agent import VshAgentDeps, create_vsh_function_toolset
+
+deps = VshAgentDeps.from_path("/path/to/workspace")
+agent = Agent(
+    os.environ["MODEL_NAME"],
+    deps_type=VshAgentDeps,
+    toolsets=[create_vsh_function_toolset()],
+)
+```
+
+## Configuration
+
+| Variable | Default | Purpose |
+|----------|---------|---------|
+| `VSH_DATA_DIR` | `~/.vsh` | JSON persistence directory |
+| `VSH_PERSIST` | `1` | Set `0` to disable disk writes |
+| `VSH_PROTECTED_PATTERNS` | built-in defaults | Comma-separated protected path globs |
+| `VSH_PROTECTED_PATTERNS_FILE` | — | Newline-separated protected globs file |
+| `VSH_MAX_TOUCHED_PATHS` | `500` | Simulation limit for touched paths |
+| `MODEL_NAME` | — | Live agent model id (demo) |
+
+## Development
+
+```bash
+ruff check src tests
+ruff format src tests
+ty check
+basedpyright src tests
+pytest tests/
+```
+
+## Performance benchmarks
+
+Compare every vsh command against native shell (5 runs, median + min/max, plots):
+
+```bash
+uv run python playground/benchmark_vsh_vs_native.py
+```
+
+Reports land in `playground/reports/<timestamp>/`. See [playground/README.md](playground/README.md).
+
+## License
+
+Apache-2.0

vbash-0.2.0/README.md

@@ -0,0 +1,130 @@
+# vsh
+
+Validation-first command engine for AI agents operating on workspaces.
+
+`vsh` is not a POSIX shell emulator. It is a **safe command planning and execution control layer** for AI agents: shell-like intent becomes typed `StructuredCommand` models, side effects are simulated on a workspace snapshot, plans are approved, drift is revalidated, and only then are mutations applied to the real filesystem. Read commands validate path access and return captured stdout on execution; simulation does not stream file contents.
+
+## Install
+
+```bash
+uv sync
+```
+
+`uv sync` installs the project plus `dev` and `agent` dependency groups (including `pydantic-ai`).
+
+For pip-only workflows:
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev,agent]"
+```
+
+## Quick start
+
+```bash
+vsh search ls
+vsh schema vsh_list
+vsh serve
+```
+
+## End-to-end lifecycle
+
+```python
+from vsh import LsCommand
+from vsh.execute import execute_approved
+from vsh.plans import approve_plan
+from vsh.simulate.engine import simulate_command
+from vsh.snapshot.builder import snapshot_workspace
+
+workspace = "/path/to/project"
+snapshot = snapshot_workspace(workspace, cwd=workspace)
+result = simulate_command(LsCommand(path=".", all=True), snapshot)
+token = approve_plan(result.plan_id)
+execution = execute_approved(token.token)
+
+print(execution.applied, execution.matches_prediction)
+```
+
+Flow: **search → get_schema → snapshot → simulate → approve → execute_approved**
+
+## Documentation
+
+- [Architecture](docs/ARCHITECTURE.md) — modules, lifecycle, drift detection, persistence
+- [API reference](docs/API.md) — public Python/MCP surface
+- [CodeMode MCP server](docs/CODEMODE.md) — discovery-first FastMCP server and prompts
+
+## MCP
+
+`vsh serve` starts the default FastMCP server.
+
+For **CodeMode-style discovery** (search → schema on demand → simulate → approve → execute), use the dedicated server:
+
+```bash
+vsh serve-codemode
+# or
+vsh-codemode
+```
+
+See [docs/CODEMODE.md](docs/CODEMODE.md) for the CodeMode inspiration, prompts, and client config examples.
+
+Both servers expose the same compact tool surface:
+
+- tools: `search`, `get_schema`, `snapshot_workspace`, `simulate`, `approve`, `execute_approved`
+- resources: workspace snapshot/projection, command spec cards, simulation records
+
+## pydantic-ai agent
+
+```bash
+cp .env.example .env
+# fill in MODEL_NAME and OPENROUTER_API_KEY
+
+uv run python examples/pydantic_ai_agent_demo.py --mode live
+```
+
+```python
+from pydantic_ai import Agent
+from vsh.agent import VshAgentDeps, create_vsh_function_toolset
+
+deps = VshAgentDeps.from_path("/path/to/workspace")
+agent = Agent(
+    os.environ["MODEL_NAME"],
+    deps_type=VshAgentDeps,
+    toolsets=[create_vsh_function_toolset()],
+)
+```
+
+## Configuration
+
+| Variable | Default | Purpose |
+|----------|---------|---------|
+| `VSH_DATA_DIR` | `~/.vsh` | JSON persistence directory |
+| `VSH_PERSIST` | `1` | Set `0` to disable disk writes |
+| `VSH_PROTECTED_PATTERNS` | built-in defaults | Comma-separated protected path globs |
+| `VSH_PROTECTED_PATTERNS_FILE` | — | Newline-separated protected globs file |
+| `VSH_MAX_TOUCHED_PATHS` | `500` | Simulation limit for touched paths |
+| `MODEL_NAME` | — | Live agent model id (demo) |
+
+## Development
+
+```bash
+ruff check src tests
+ruff format src tests
+ty check
+basedpyright src tests
+pytest tests/
+```
+
+## Performance benchmarks
+
+Compare every vsh command against native shell (5 runs, median + min/max, plots):
+
+```bash
+uv run python playground/benchmark_vsh_vs_native.py
+```
+
+Reports land in `playground/reports/<timestamp>/`. See [playground/README.md](playground/README.md).
+
+## License
+
+Apache-2.0