🛠️ Works On My Machine (WOMM)

WOMM is a command-line tool that creates Python and JavaScript projects from templates, configures existing ones, and keeps your PATH and Windows context menu under control.

Installed as womm-cli, used as womm. The name womm was already taken on PyPI, so the package is published as womm-cli. You only type that name to install or upgrade. The former name works-on-my-machine is no longer maintained: its last release, 3.2.4, exists only to carry that notice.

📦 Installation

# Recommended: isolated install, uv provisions Python if needed
uv tool install womm-cli
uv tool update-shell   # once, if `womm` is not on your PATH yet

# Any other PEP 517 installer works on the same wheel
pipx install womm-cli
pip install --user womm-cli

# Run it without installing anything
uvx womm-cli --help

# Unreleased code, straight from the repository
uv tool install git+https://github.com/neuraaak/WOMM.git

Upgrade with uv tool upgrade womm-cli, remove with uv tool uninstall womm-cli. Neither touches your data in ~/.womm.

Requires Python 3.13 or later — uv tool install provisions it for you.

🚀 Quick Start

# Create a Python project, then prepare its environment
womm create official/python ./hello-womm --setup

# Configure a project you already have
cd my-existing-project
womm setup detect

# Check what WOMM resolves on this machine
womm doctor

🎯 Key Features

• ✅ Project creation from Copier templates, with real questions and a catalog you can extend
• ✅ Two official templates: Python (optional Django) and JavaScript/TypeScript (optional React or Vue)
• ✅ Environment setup for existing projects: virtual environment, dependencies, dev tooling, git hooks
• ✅ PATH management, with an automatic backup before every change
• ✅ Windows context menu entries, with backups and selective restore
• ✅ Read-only dependency report across runtimes and package managers
• ✅ User data kept in ~/.womm, untouched by upgrades

💻 CLI Usage

womm create TEMPLATE DESTINATION    # render a catalog template
womm setup detect|python|javascript # configure an existing project
womm template list|show|add|init|update|remove
womm deps check|status|list         # report runtimes and package managers
womm path list|add|remove|backup    # inspect and manage your PATH
womm context register|list|unregister|quick-setup|backup  # Windows only
womm system detect|refresh-env      # system information, Windows refresh
womm doctor                         # what this installation resolves

Every command takes -h for its own options. The full list is in the command reference.

📚 Documentation

Complete documentation is available at neuraaak.github.io/WOMM

🧪 Testing

uv run pytest                 # unit tests with coverage
uv run pytest tests/unit -q   # quick run

🛠️ Development Setup

git clone https://github.com/neuraaak/WOMM.git
cd WOMM

uv sync --group dev        # install the project and its dev tooling
uv run pre-commit install  # enable the git hooks

uv run ruff check .        # lint
uv run ruff format .       # format
uv run ty check .          # type check
uv run lint-imports        # layer contracts
uv run mkdocs serve        # preview the documentation

📦 Dependencies

External programs WOMM reports on but never installs: Python 3.13+, Node.js 18+, git 2.30+, and one of pip, uv, npm or yarn.

📝 License

Released under the MIT License.

🔗 Links

• Repository — github.com/neuraaak/WOMM
• PyPI — pypi.org/project/womm-cli
• Documentation — neuraaak.github.io/WOMM
• Issues — github.com/neuraaak/WOMM/issues

WOMM – Scaffold it once, run it anywhere.