Skip to content

Commit

Permalink
on default don't update pnpm lockfile
Browse files Browse the repository at this point in the history
  • Loading branch information
monilpat committed Dec 15, 2024
1 parent a09058d commit eff83ec
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 3 deletions.
1 change: 1 addition & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
node-linker=hoisted
frozen-lockfile=true
14 changes: 14 additions & 0 deletions docs/docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,18 @@ Before getting started with Eliza, ensure you have:
pnpm install
```

# Quickstart Guide Update

**Important Note on pnpm Lockfile Management**

By default, the `pnpm` lockfile will not be updated during installations based off of .npmrc frozen-lockfile=true. To update the lockfile, you need to run the command:

```bash
pnpm i --no-frozen-lockfile
```

Please only use this command when you are bumping the version of a package or adding a new package to your package.json. This practice helps maintain consistency in your project's dependencies and prevents unintended changes to the lockfile.

Build the local libraries

```bash
Expand Down Expand Up @@ -289,6 +301,8 @@ pnpm start --characters="characters/trump.character.json,characters/tate.charact
pnpm i
```



## Next Steps

Once you have your agent running, explore:
Expand Down
3 changes: 0 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
{
"name": "eliza",
"scripts": {
"install": "pnpm i --frozen-lockfile",
"i": "pnpm i --frozen-lockfile",
"update": "pnpm i",
"preinstall": "npx only-allow pnpm",
"build": "turbo run build --filter=!eliza-docs",
"build-docker": "turbo run build",
Expand Down

0 comments on commit eff83ec

Please sign in to comment.