diff --git a/.changeset/cuddly-days-wink.md b/.changeset/cuddly-days-wink.md new file mode 100644 index 00000000000..78bb3ea5f82 --- /dev/null +++ b/.changeset/cuddly-days-wink.md @@ -0,0 +1,6 @@ +--- +docs: standardize shell commands in the docs +--- + +Removed `yarn`, ensured all examples have two variations and tabularized +examples. diff --git a/apps/docs/src/getting-started.md b/apps/docs/src/getting-started.md index 64ec3a3f0a4..e71ed1ccd9b 100644 --- a/apps/docs/src/getting-started.md +++ b/apps/docs/src/getting-started.md @@ -12,10 +12,6 @@ To begin, you need to add the `fuels` dependency to your project. You can do thi npm install fuels --save ``` -```sh [yarn] -yarn add fuels -``` - ```sh [pnpm] pnpm add fuels ``` diff --git a/apps/docs/src/guide/abi-typegen/generating-types-from-abi.md b/apps/docs/src/guide/abi-typegen/generating-types-from-abi.md index c01e89a8160..93a2b44e051 100644 --- a/apps/docs/src/guide/abi-typegen/generating-types-from-abi.md +++ b/apps/docs/src/guide/abi-typegen/generating-types-from-abi.md @@ -5,7 +5,7 @@ First we install `fuels` to our project: ```console -yarn add fuels +pnpm add fuels ``` ## Help @@ -13,7 +13,7 @@ yarn add fuels A first glance at the docs: ```console -$ yarn exec fuels typegen -h +$ pnpm fuels typegen -h Usage: fuels typegen [options] @@ -36,7 +36,7 @@ You can generate types for a Sway contract using the command below: ```console -yarn exec fuels typegen -i ./abis/*-abi.json -o ./types +pnpm fuels typegen -i ./abis/*-abi.json -o ./types ``` @@ -57,7 +57,7 @@ You can omit the `--contract` option here since it's the default. To generate types for a Sway script, use the `--script` flag: ```console -yarn exec fuels typegen -i ./abis/*-abi.json -o ./types --script +pnpm fuels typegen -i ./abis/*-abi.json -o ./types --script ``` ## Generating Types for Predicates @@ -65,7 +65,7 @@ yarn exec fuels typegen -i ./abis/*-abi.json -o ./types --script To generate types for a Sway predicate, use the `--predicate` flag: ```console -yarn exec fuels typegen -i ./abis/*-abi.json -o ./types --predicate +pnpm fuels typegen -i ./abis/*-abi.json -o ./types --predicate ``` --- diff --git a/apps/docs/src/guide/abi-typegen/using-generated-types.md b/apps/docs/src/guide/abi-typegen/using-generated-types.md index eb2c4032091..27c793061f9 100644 --- a/apps/docs/src/guide/abi-typegen/using-generated-types.md +++ b/apps/docs/src/guide/abi-typegen/using-generated-types.md @@ -5,7 +5,7 @@ After generating types via: ```console -yarn exec fuels typegen -i ./abis/*-abi.json -o ./types +pnpm fuels typegen -i ./abis/*-abi.json -o ./types ``` We can use these files like so: @@ -59,7 +59,7 @@ const contract = await MyContract__factory.deployContract(bytecode, wallet, { After generating types via: ```console -yarn exec fuels typegen -i ./abis/*-abi.json -o ./types --script +pnpm fuels typegen -i ./abis/*-abi.json -o ./types --script ``` We can use these files like so: @@ -87,7 +87,7 @@ Consider the following predicate: Now, after generating types via: ```console -yarn exec fuels typegen -i ./abis/*-abi.json -o ./types --predicate +pnpm fuels typegen -i ./abis/*-abi.json -o ./types --predicate ``` We can use these files like so: diff --git a/apps/docs/src/guide/cli/index.md b/apps/docs/src/guide/cli/index.md index 695f9a85cc1..96e09c32b4d 100644 --- a/apps/docs/src/guide/cli/index.md +++ b/apps/docs/src/guide/cli/index.md @@ -30,10 +30,18 @@ my-fuel-dapp # NextJS app or similar Add it to your `my-fuel-dapp` project: -```console +::: code-group + +```console [npm] npm install fuels --save ``` +```console [pnpm] +pnpm add fuels +``` + +::: + ## Double-checking ```console diff --git a/apps/docs/src/index.md b/apps/docs/src/index.md index a959bb6af1e..82df33bfd08 100644 --- a/apps/docs/src/index.md +++ b/apps/docs/src/index.md @@ -34,18 +34,18 @@ Learn more about the Fuel Ecosystem. ## Install -#### YARN +::: code-group -```sh -yarn add fuels +```sh [pnpm] +pnpm add fuels ``` -#### NPM - -```sh +```sh [npm] npm install fuels --save ``` +::: + ## Import diff --git a/packages/abi-coder/README.md b/packages/abi-coder/README.md index 7435619ed94..24cd682c3f7 100644 --- a/packages/abi-coder/README.md +++ b/packages/abi-coder/README.md @@ -25,7 +25,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/) ### Installation ```sh -yarn add @fuel-ts/abi-coder +pnpm add @fuel-ts/abi-coder # or npm add @fuel-ts/abi-coder ``` @@ -35,7 +35,7 @@ npm add @fuel-ts/abi-coder Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package: ```sh -yarn add fuels +pnpm add fuels # or npm add fuels ``` diff --git a/packages/abi-typegen/README.md b/packages/abi-typegen/README.md index 3eb5025ae4d..fb4dbc698d3 100644 --- a/packages/abi-typegen/README.md +++ b/packages/abi-typegen/README.md @@ -22,9 +22,9 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/guide/abi-typeg ## Installation ```sh -yarn add @fuel-ts/abi-typegen +pnpm add @fuel-ts/abi-typegen # or -npm add @fuel-ts/abi-typegen +nppnpmm add @fuel-ts/abi-typegen ``` ## Help @@ -76,7 +76,7 @@ import { ProgramTypeEnum, runTypegen } from "@fuel-ts/abi-typegen"; Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package: ```sh -yarn add fuels +pnpm add fuels # or npm add fuels ``` diff --git a/packages/address/README.md b/packages/address/README.md index 17801eda39c..d3a9ceb2340 100644 --- a/packages/address/README.md +++ b/packages/address/README.md @@ -23,7 +23,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/guide/types/add ### Installation ```sh -yarn add @fuel-ts/address +pnpm add @fuel-ts/address # or npm add @fuel-ts/address ``` @@ -33,7 +33,7 @@ npm add @fuel-ts/address Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package: ```sh -yarn add fuels +pnpm add fuels # or npm add fuels ``` diff --git a/packages/contract/README.md b/packages/contract/README.md index c84e57939d0..a399d3306f1 100644 --- a/packages/contract/README.md +++ b/packages/contract/README.md @@ -23,7 +23,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/guide/contracts ### Installation ```sh -yarn add @fuel-ts/contract +pnpm add @fuel-ts/contract # or npm add @fuel-ts/contract ``` @@ -33,7 +33,7 @@ npm add @fuel-ts/contract Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package: ```sh -yarn add fuels +pnpm add fuels # or npm add fuels ``` diff --git a/packages/crypto/README.md b/packages/crypto/README.md index 03bbf211945..539fe19ccca 100644 --- a/packages/crypto/README.md +++ b/packages/crypto/README.md @@ -25,7 +25,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/) ### Installation ```sh -yarn add @fuel-ts/crypto +pnpm add @fuel-ts/crypto # or npm add @fuel-ts/crypto ``` @@ -35,7 +35,7 @@ npm add @fuel-ts/crypto Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package: ```sh -yarn add fuels +pnpm add fuels # or npm add fuels ``` diff --git a/packages/errors/README.md b/packages/errors/README.md index 927403e7915..bde1e5f4f52 100644 --- a/packages/errors/README.md +++ b/packages/errors/README.md @@ -27,7 +27,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/) ### Installation ```sh -yarn add @fuel-ts/errors +pnpm add @fuel-ts/errors # or npm add @fuel-ts/errors ``` diff --git a/packages/hasher/README.md b/packages/hasher/README.md index 45d03afeaf0..2a2292a8524 100644 --- a/packages/hasher/README.md +++ b/packages/hasher/README.md @@ -25,7 +25,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/) ### Installation ```sh -yarn add @fuel-ts/hasher +pnpm add @fuel-ts/hasher # or npm add @fuel-ts/hasher ``` @@ -35,7 +35,7 @@ npm add @fuel-ts/hasher Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package: ```sh -yarn add fuels +pnpm add fuels # or npm add fuels ``` diff --git a/packages/hdwallet/README.md b/packages/hdwallet/README.md index 3cadaa07c3c..31804b1b8f4 100644 --- a/packages/hdwallet/README.md +++ b/packages/hdwallet/README.md @@ -25,7 +25,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/) ### Installation ```sh -yarn add @fuel-ts/hdwallet +pnpm add @fuel-ts/hdwallet # or npm add @fuel-ts/hdwallet ``` @@ -35,7 +35,7 @@ npm add @fuel-ts/hdwallet Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package: ```sh -yarn add fuels +pnpm add fuels # or npm add fuels ``` diff --git a/packages/interfaces/README.md b/packages/interfaces/README.md index fbb8b3a2b8b..49dd79edce1 100644 --- a/packages/interfaces/README.md +++ b/packages/interfaces/README.md @@ -25,7 +25,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/) ### Installation ```sh -yarn add @fuel-ts/interfaces +pnpm add @fuel-ts/interfaces # or npm add @fuel-ts/interfaces ``` @@ -35,7 +35,7 @@ npm add @fuel-ts/interfaces Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package: ```sh -yarn add fuels +pnpm add fuels # or npm add fuels ``` diff --git a/packages/math/README.md b/packages/math/README.md index 72e7e5e83b6..db5d27e4bf2 100644 --- a/packages/math/README.md +++ b/packages/math/README.md @@ -27,7 +27,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/) ### Installation ```sh -yarn add @fuel-ts/math +pnpm add @fuel-ts/math # or npm add @fuel-ts/math ``` @@ -37,7 +37,7 @@ npm add @fuel-ts/math Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package: ```sh -yarn add fuels +pnpm add fuels # or npm add fuels ``` diff --git a/packages/merkle/README.md b/packages/merkle/README.md index a2deb116cf5..480010e4a97 100644 --- a/packages/merkle/README.md +++ b/packages/merkle/README.md @@ -30,7 +30,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/) ### Installation ```sh -yarn add @fuel-ts/merkle +pnpm add @fuel-ts/merkle # or npm add @fuel-ts/merkle ``` @@ -40,7 +40,7 @@ npm add @fuel-ts/merkle Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package: ```sh -yarn add fuels +pnpm add fuels # or npm add fuels ``` diff --git a/packages/mnemonic/README.md b/packages/mnemonic/README.md index 8bf679da927..51ccc70777c 100644 --- a/packages/mnemonic/README.md +++ b/packages/mnemonic/README.md @@ -25,7 +25,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/) ### Installation ```sh -yarn add @fuel-ts/mnemonic +pnpm add @fuel-ts/mnemonic # or npm add @fuel-ts/mnemonic ``` @@ -35,7 +35,7 @@ npm add @fuel-ts/mnemonic Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package: ```sh -yarn add fuels +pnpm add fuels # or npm add fuels ``` diff --git a/packages/predicate/README.md b/packages/predicate/README.md index 43e2afac04d..4811e836b9b 100644 --- a/packages/predicate/README.md +++ b/packages/predicate/README.md @@ -23,7 +23,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/guide/predicate ### Installation ```sh -yarn add @fuel-ts/predicate +pnpm add @fuel-ts/predicate # or npm add @fuel-ts/predicate ``` @@ -33,7 +33,7 @@ npm add @fuel-ts/predicate Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package: ```sh -yarn add fuels +pnpm add fuels # or npm add fuels ``` diff --git a/packages/program/README.md b/packages/program/README.md index e701b956bed..b8c76974413 100644 --- a/packages/program/README.md +++ b/packages/program/README.md @@ -25,7 +25,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/) ### Installation ```sh -yarn add @fuel-ts/program +pnpm add @fuel-ts/program # or npm add @fuel-ts/program ``` @@ -35,7 +35,7 @@ npm add @fuel-ts/program Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package: ```sh -yarn add fuels +pnpm add fuels # or npm add fuels ``` diff --git a/packages/providers/README.md b/packages/providers/README.md index acd5a8c1753..7c4fed3c0ca 100644 --- a/packages/providers/README.md +++ b/packages/providers/README.md @@ -23,7 +23,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/guide/providers ### Installation ```sh -yarn add @fuel-ts/providers +pnpm add @fuel-ts/providers # or npm add @fuel-ts/providers ``` @@ -33,7 +33,7 @@ npm add @fuel-ts/providers Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package: ```sh -yarn add fuels +pnpm add fuels # or npm add fuels ``` diff --git a/packages/signer/README.md b/packages/signer/README.md index 34a210edada..a59eb7d6545 100644 --- a/packages/signer/README.md +++ b/packages/signer/README.md @@ -25,7 +25,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/) ### Installation ```sh -yarn add @fuel-ts/signer +pnpm add @fuel-ts/signer # or npm add @fuel-ts/signer ``` @@ -35,7 +35,7 @@ npm add @fuel-ts/signer Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package: ```sh -yarn add fuels +pnpm add fuels # or npm add fuels ``` diff --git a/packages/testcases/README.md b/packages/testcases/README.md index 61af8f50988..df3866cae5b 100644 --- a/packages/testcases/README.md +++ b/packages/testcases/README.md @@ -25,7 +25,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/) ### Installation ```sh -yarn add @fuel-ts/testcases +pnpm add @fuel-ts/testcases # or npm add @fuel-ts/testcases ``` @@ -35,7 +35,7 @@ npm add @fuel-ts/testcases Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package: ```sh -yarn add fuels +pnpm add fuels # or npm add fuels ``` diff --git a/packages/transactions/README.md b/packages/transactions/README.md index 137cffb09c8..dea49a86ef9 100644 --- a/packages/transactions/README.md +++ b/packages/transactions/README.md @@ -25,7 +25,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/) ### Installation ```sh -yarn add @fuel-ts/transactions +pnpm add @fuel-ts/transactions # or npm add @fuel-ts/transactions ``` @@ -35,7 +35,7 @@ npm add @fuel-ts/transactions Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package: ```sh -yarn add fuels +pnpm add fuels # or npm add fuels ``` diff --git a/packages/utils/README.md b/packages/utils/README.md index 61ece858625..fb0e694228c 100644 --- a/packages/utils/README.md +++ b/packages/utils/README.md @@ -23,7 +23,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/) ## Installation ```sh -yarn add @fuel-ts/utils +pnpm add @fuel-ts/utils # or npm add @fuel-ts/utils ``` diff --git a/packages/versions/README.md b/packages/versions/README.md index f87acc9c626..3b38dbad3ad 100644 --- a/packages/versions/README.md +++ b/packages/versions/README.md @@ -31,7 +31,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/) ## Installation ```sh -yarn add @fuel-ts/versions +pnpm add @fuel-ts/versions # or npm add @fuel-ts/versions ``` @@ -64,7 +64,7 @@ You have all the right versions! ⚡ Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package: ```sh -yarn add fuels +pnpm add fuels # or npm add fuels ``` diff --git a/packages/wallet-manager/README.md b/packages/wallet-manager/README.md index 1c1493caa24..d7bd4fa85f0 100644 --- a/packages/wallet-manager/README.md +++ b/packages/wallet-manager/README.md @@ -25,7 +25,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/) ### Installation ```sh -yarn add @fuel-ts/wallet-manager +pnpm add @fuel-ts/wallet-manager # or npm add @fuel-ts/wallet-manager ``` @@ -35,7 +35,7 @@ npm add @fuel-ts/wallet-manager Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package: ```sh -yarn add fuels +pnpm add fuels # or npm add fuels ``` diff --git a/packages/wallet/README.md b/packages/wallet/README.md index 2b7bb99a364..4ff975221bb 100644 --- a/packages/wallet/README.md +++ b/packages/wallet/README.md @@ -23,7 +23,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/guide/wallets/) ### Installation ```sh -yarn add @fuel-ts/wallet +pnpm add @fuel-ts/wallet # or npm add @fuel-ts/wallet ``` @@ -33,7 +33,7 @@ npm add @fuel-ts/wallet Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package: ```sh -yarn add fuels +pnpm add fuels # or npm add fuels ``` diff --git a/packages/wordlists/README.md b/packages/wordlists/README.md index 57d59705e3f..34761cb2996 100644 --- a/packages/wordlists/README.md +++ b/packages/wordlists/README.md @@ -25,7 +25,7 @@ See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/) ### Installation ```sh -yarn add @fuel-ts/wordlists +pnpm add @fuel-ts/wordlists # or npm add @fuel-ts/wordlists ``` @@ -35,7 +35,7 @@ npm add @fuel-ts/wordlists Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package: ```sh -yarn add fuels +pnpm add fuels # or npm add fuels ```