Following docs/how-to/install.md exactly on a clean machine fails at the first step.
Repro
git clone https://github.com/nustackdev/nu
cd nu
make sync
Using CPython 3.12.13
Creating virtual environment at: .venv
error: Distribution not found at: file:///Users/me/code/virtuals
make: *** [sync] Error 2
Cause
pyproject.toml declares three editable path dependencies pointing one level up:
[tool.uv.sources]
virtuals-py = { path = "../virtuals", editable = true }
invisibles-py = { path = "../invisibles", editable = true }
kh57 = { path = "../kh57", editable = true }
The install page never mentions them, so a first time user hits a bare "Distribution not found" with no indication that three more clones are required, or that they must be siblings of nu/ rather than nested inside it.
Suggested patch
In docs/content/docs/how-to/install.md, under "Install the Python side":
Nu resolves `virtuals`, `invisibles`, and `kh57` as editable path dependencies one
directory up, so clone all four as siblings:
```bash
mkdir -p ~/code && cd ~/code
git clone https://github.com/nustackdev/nu
git clone https://github.com/nustackdev/virtuals
git clone https://github.com/nustackdev/invisibles
git clone https://github.com/nustackdev/kh57
cd nu
make sync
```
Adding it to "Common errors" as well would catch anyone who cloned into a nested layout.
Happy to send this as a PR if forking gets enabled; the repo currently has allow_forking: false and read only collaborator access.
Following
docs/how-to/install.mdexactly on a clean machine fails at the first step.Repro
git clone https://github.com/nustackdev/nu cd nu make syncCause
pyproject.tomldeclares three editable path dependencies pointing one level up:The install page never mentions them, so a first time user hits a bare "Distribution not found" with no indication that three more clones are required, or that they must be siblings of
nu/rather than nested inside it.Suggested patch
In
docs/content/docs/how-to/install.md, under "Install the Python side":Adding it to "Common errors" as well would catch anyone who cloned into a nested layout.
Happy to send this as a PR if forking gets enabled; the repo currently has
allow_forking: falseand read only collaborator access.