gaztec 1.0.2 → 1.0.3

package/README.md

@@ -1,30 +1,70 @@
 # Aztec version manager
 
-Manage your `aztec` versions without hussle. Automatically switch between versions in projects by creating a `.gaztecrc` file.
+Manage your `aztec` versions without hassle. Automatically switch between versions in projects by creating a `.aztecrc` file.
 
-## Installation
+## Why gaztec?
+
+- **No installation** — just run `npx gaztec` and go. No global install, no `npm i` required
+- **Automatic version switching** — drop a `.aztecrc` in your project and gaztec picks the right version
+- **No `aztec-up` needed** — versions are fetched on demand when you run a command
+- **Simple** — `npx gaztec <command>` replaces `aztec <command>` everywhere
+
+## Quick start
 
 ```sh
-npm i -g gaztec
+# create a file that defines the version of Aztec for your project
+echo "4.0.0-devnet.2-patch.2" > .aztecrc
+
+# use gaztec where you would use aztec (no install needed)
+npx gaztec --version
+#> 4.0.0-devnet.2-patch.2
 ```
 
-You can also install it locally and use it in your project:
+## `gaztec nargo`
+
+`gaztec nargo` exposes the pinned version of `nargo` that is compatible with the installed version of Aztec. Useful if you don't want to manage the version of `nargo` yourself.
 
 ```sh
-npm i gaztec -D
+# runs `nargo check` with the pinned version of `nargo`
+npx gaztec nargo check
 ```
 
-**WARNING**: if you use `pnpm` or `yarn`, you must use `npx gaztec` instead of `pnpm gaztec` or `yarn gaztec`.
+## Installation (optional)
 
-## Use in your project
+You can install gaztec globally or as a dev dependency (to pin the version) if you prefer:
 
 ```sh
-# create a file that defines the version of Aztec for your project
-echo "4.0.0-devnet.2-patch.2" > .gaztecrc
+npm i -g gaztec
+# or
+npm i gaztec -D
+```
 
-# use `gaztec` where you would use `aztec`
-gaztec --version
-#> 4.0.0-devnet.2-patch.2
+**Note**: with `pnpm` or `yarn`, use `npx gaztec` instead of `pnpm gaztec` or `yarn gaztec`.
+
+## CI
+
+Commit a `.aztecrc` file to your repo and use `npx gaztec` in your workflow. No setup step needed:
+
+```yaml
+name: Test
+
+on: [push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 24
+
+      - name: Compile Aztec contracts
+        run: npx gaztec compile
+
+      - name: Start Aztec Local Network
+        run: npx gaztec start --local-network
 ```
 
 ## Compatibility with `aztec`

package/gaztec

@@ -3,4 +3,10 @@ set -euo pipefail
 
 source "$(dirname -- "${BASH_SOURCE[0]}")/gaztec-install"
 
-$AZTEC $@
+# if the subcommand is "nargo", run nargo instead
+if [[ "$1" == "nargo" ]]; then
+  shift
+  $NARGO $@
+else
+  $AZTEC $@
+fi

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gaztec",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "type": "module",
   "description": "Aztec version manager",
   "repository": {