Environment setup

You need two things: the zyme CLI and a coding agent. You usually don’t install the CLI by hand: the Task setup prompt does it as its first step. This page covers both the agent-driven path and the manual one.

Paste this into your coding agent (Claude Code, Codex, Cursor, …). It clones the repo, installs the CLI, and verifies it:

Clone https://github.com/ElliotXie/autozyme.git, then install the AutoZyme CLI:
pip install -e autozyme/autozyme_cli/
Verify it worked by running: zyme --version

That’s the whole setup. Continue to 1. Task setup. The Task setup prompt also self-installs the CLI, so if you start there you can skip this page entirely.

Set it up yourself (manual)

Prefer to run the commands? Clone the repo and install the CLI in editable mode:

git clone https://github.com/ElliotXie/autozyme.git
cd autozyme && pip install -e autozyme_cli/
zyme --version

Editable (-e) means a later git pull picks up framework updates with no reinstall.

If zyme is not found:

  • Confirm pip installed into the Python you’re actually using (which python, python -c "import sys; print(sys.executable)").
  • On Windows, confirm the Scripts directory is on PATH; where zyme should resolve to a .exe shim.

Shipping a patch? Also install the libraries

The packaging agent lifts your converged patch into the AutoZyme libraries. For that, install them in editable mode from the clone root. You can skip this until packaging; the agent tells you if it’s missing.

pip install -e autozyme_py/                                       # Python library
Rscript -e 'remotes::install_local("autozyme_r", force = TRUE)'   # R library