From eff83ec4c7d510517d6de931af363f28fc496b4d Mon Sep 17 00:00:00 2001 From: Monil Patel Date: Sun, 15 Dec 2024 12:35:45 -0800 Subject: [PATCH] on default don't update pnpm lockfile --- .npmrc | 1 + docs/docs/quickstart.md | 14 ++++++++++++++ package.json | 3 --- 3 files changed, 15 insertions(+), 3 deletions(-) diff --git a/.npmrc b/.npmrc index d67f3748837..0f6a4a767d1 100644 --- a/.npmrc +++ b/.npmrc @@ -1 +1,2 @@ node-linker=hoisted +frozen-lockfile=true \ No newline at end of file diff --git a/docs/docs/quickstart.md b/docs/docs/quickstart.md index 206e1486025..ff29978f680 100644 --- a/docs/docs/quickstart.md +++ b/docs/docs/quickstart.md @@ -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 @@ -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: diff --git a/package.json b/package.json index fab48aee289..cb2da2b438a 100644 --- a/package.json +++ b/package.json @@ -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",