Skip to content

Commit

Permalink
Updated quickstart.md to contemplate common issue
Browse files Browse the repository at this point in the history
Issue Found

While trying to run the project I encountered an issue. There was no specification on the pnpm version and even though I had all the other versions correctly, I was getting the same constant error. 

The project requires specific versions of pnpm (9+?) as defined in the package.json, but when trying to install dependencies, I kept getting ERR_PNPM_META_FETCH_FAIL errors and broken lockfile warnings.

The root cause was a mismatch between my system's pnpm version and the one specified in the project.

Solution

Using nvm + corepack solved the issue. After fixing this on my end, I'm adding this documentation to improve experience!

'''
   corepack enable
   corepack prepare [email protected] --activate
'''

Helped me solve the issue.
  • Loading branch information
fede2442 authored Dec 5, 2024
1 parent 0a03140 commit c2a4675
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions docs/docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ sidebar_position: 2

Before getting started with Eliza, ensure you have:

- [Node.js 23.3.0](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
- [pnpm](https://pnpm.io/installation)
- [Python 2.7+](https://www.python.org/downloads/)
- [Node.js 23+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
- [pnpm 9+](https://pnpm.io/installation)
- Git for version control
- A code editor ([VS Code](https://code.visualstudio.com/) or [VSCodium](https://vscodium.com) recommended)
- [CUDA Toolkit](https://developer.nvidia.com/cuda-toolkit) (optional, for GPU acceleration)
Expand All @@ -35,7 +36,9 @@ Before getting started with Eliza, ensure you have:
Switch to latest tagged release

```bash
git checkout v0.0.10
# Checkout the latest release
# This project iterates fast, so we recommend checking out the latest release
git checkout $(git describe --tags --abbrev=0)
```

Install dependencies
Expand Down

0 comments on commit c2a4675

Please sign in to comment.