poli0981andClaude Opus 5 6840e0378a docs: the write path, the waiver that gates it, and one claim made true
DATA-FLOW gains **invariant 6** and §9.1's state machine. §9.1 and §9.2 are scoped to a
mutating *engine* call and do not reach `ruff check --fix`, which rewrites the user's source
tree — a thing no snapshot in this application describes, so one taken here would have no
consumer that could use it. That is invariant 2's own argument for the pip-upkeep exemption,
a second time, and like that one the exemption is **made visible rather than silent**: the
confirm states that PipDock cannot undo the change and that only the user's version control
can. The fifth proof shape is a `HealthReport` plus a server-checked `FixConsent`.

**A SECURITY paragraph was ahead of the code, and the code caught up rather than the
paragraph coming back.** §2 now says the project folder is canonicalized, existence-checked,
and refused when it resolves inside PipDock's own tools directory — so `validate_project`
exists, `..` is handled by comparing canonical paths rather than strings, and running Health
against `%LOCALAPPDATA%\PipDock\tools` answers `PD-ENV-003`. ruff would otherwise have
rewritten PipDock's own venv, and that failure would have looked like a corrupted install
rather than like the fix that caused it.

§2 also records the git resolution finding: this is the one place PipDock runs a
PATH-resolved program with a user-controlled working directory, and a planted `git.exe` does
**not** win — verified by planting one, not by reasoning about `CreateProcess`. §8 gains the
one exception to "all state is local".

CODE-HEALTH-SPEC §5 replaces "recommends a clean git tree" with what was built. CLI-SPEC §3
carries the `--yes` rule where someone reading the flag will see it. UI-SPEC §5 gains the fix
row and §7 names the confirm alongside the other three destructive ones, with the
forced-colors requirement each of them shares. ARCHITECTURE §7 gains `health_dirty`.

CLAUDE.md's waiver list goes 2 → 3, and the no-snapshot decision is written where the next
person will look for it rather than left to be re-derived.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-08-13 19:30:12 +07:00
2026-07-27 12:02:38 +07:00

PipDock

A friendly dock for your Python environments. Inspect, install, update, and clean up Python packages in bulk — through a keyboard-first GUI or a scriptable CLI — without ever hand-typing another pip install incantation or guessing why an upgrade broke your project.

Repo: poli0981/pipdock · License: GPL-3.0 · Platform: Windows 10/11 (v1) · Status: design phase


Why PipDock

pip is powerful but unforgiving: it does not preview what an upgrade will change, pip uninstall removes packages that other packages still need without a word of warning, and a failed bulk update leaves you guessing what state your environment is in. PipDock wraps the official resolvers (pip or uv — your choice) with:

  • Preview before touch — every install/update runs a dry-run resolve first and shows you exactly what will change.
  • Three-way conflict handling — when the latest version of a package would break another, choose compatible version (safe default), skip, or force latest with a clear "this will break X" warning.
  • Snapshots & rollback — a pip freeze snapshot is taken before every batch operation; one click restores it.
  • Reverse-dependency guard — uninstalling a package that others depend on triggers a warning listing exactly what would break.
  • Skip-and-continue execution — one failed package never aborts the batch; you get a final report: "13 successful, 2 failed" with per-package reasons.
  • Never touches itself — PipDock is a standalone binary that lives outside every environment it manages, so it can never break itself mid-update.

Features (v1)

Area What you get
Environments Auto-discovery of venvs / uv venvs / system Pythons (PEP 514 + py launcher), manual add, PEP 668 guard
Installed Full package list per env; up-to-date packages dimmed, outdated badged
Updates Bulk update with group dry-run resolve, held-back explanations, 3-way conflict choices
Search & Install Instant fuzzy search over a locally cached PyPI name index (PEP 691), metadata on demand, install queue
Uninstall Bulk uninstall with reverse-dependency warnings
Pins Exclude packages from bulk updates; auto-suggest pinning heavily-depended-on packages
Snapshots Automatic pre-batch snapshots, diff view, one-click rollback
Engine pip or uv, selectable in Settings (uv auto-detected on first run)
Code Health deptry + vulture + ruff against a project folder — unused deps, dead code, style — run from PipDock's own isolated tools env
pip upkeep Check & update pip itself per environment
CLI pipdock — full parity for core operations, JSON output, CI-friendly exit codes
i18n English + Tiếng Việt
Privacy No telemetry. Network traffic goes only to PyPI (package data) and GitHub (app updates)

Install

Download the installer (NSIS .exe or .msi) from GitHub Releases.

PipDock does not update itself — grab a new build from the same page when you want one. That is deliberate: a self-updater is a standing remote-code-execution path into a tool that already runs subprocesses against your interpreters, and it is not worth the convenience (see docs/SECURITY.md §5).

Windows SmartScreen may warn on first run because binaries are not EV-code-signed. Verify the SHA-256 checksum published with each release.

Quick start

GUI: launch PipDock → accept the first-run legal gate → pick an environment (auto-discovered or Browse…) → the Updates tab shows what's outdated → Select all → Update → review the preview → Confirm. Four clicks.

CLI:

pipdock env list
pipdock update --all --env C:\proj\.venv --strategy compatible --yes
pipdock doctor
pipdock snapshot rollback latest

Documentation

Doc Purpose
docs/PRD.md Product goals, personas, feature matrix P0–P2, non-goals
docs/ARCHITECTURE.md Crate layout, Engine trait, IPC surface, storage
docs/DATA-FLOW.md State machines for update / install / uninstall, engine command mapping
docs/UI-SPEC.md Terminal-tech design system, screens, click budgets
docs/CLI-SPEC.md Commands, flags, exit codes, JSON contracts
docs/CODE-HEALTH-SPEC.md deptry / vulture / ruff integration
docs/ERROR-CATALOG.md Error codes, stderr detection patterns, user guidance
docs/SECURITY.md Threat model, PEP 668 policy, supply-chain hygiene
docs/TESTING.md Test strategy incl. disposable-venv integration tests
docs/RELEASE-CI.md CI callers into poli0981/.github, release pipeline
docs/I18N.md EN/VI localization rules
docs/ROADMAP.md Spike week, milestones, exit criteria
legal/ EULA, Disclaimer, Privacy Policy, Third-Party Notices (linked by the in-app legal gate)

License

GPL-3.0. See LICENSE (add the standard GPL-3.0 text at repo creation). The legal documents in legal/ must be committed publicly so the in-app legal gate can link to them on GitHub.

PipDock is an independent project. It is not affiliated with or endorsed by the Python Software Foundation (Python, pip, PyPI) or Astral (uv, ruff).


Tiếng Việt (tóm tắt)

PipDock là ứng dụng Windows (GUI + CLI) giúp kiểm tra, cài đặt, cập nhật và gỡ hàng loạt gói thư viện Python một cách an toàn: luôn chạy dry-run xem trước thay đổi, xử lý xung đột phiên bản với 3 lựa chọn rõ ràng, tự chụp snapshot trước mỗi lần chạy để rollback một chạm, cảnh báo khi gỡ gói mà gói khác đang phụ thuộc, và tổng kết "13 thành công, 2 thất bại" kèm lý do từng gói. Hỗ trợ engine pip hoặc uv (chọn trong Settings), tìm gói tức thì nhờ cache chỉ mục PyPI, kèm module Code Health (deptry/vulture/ruff) để dọn dependency thừa và dead code. Không thu thập dữ liệu. Giấy phép GPL-3.0.

S
Description
No description provided
Readme GPL-3.0
3.4 MiB
0 Stars 1 Watchers 0 Forks
Languages
Rust 62.8%
TypeScript 32.9%
Python 2.4%
JavaScript 1.5%
CSS 0.4%