Always recommend run-example

Concordium · May 3, 2023 · 0315178 · 0315178
1 parent 3355cd5
commit 0315178
Show file tree

Hide file tree

Showing 20 changed files with 22 additions and 24 deletions.
diff --git a/examples/client/banPeer.ts b/examples/client/banPeer.ts
@@ -6,7 +6,7 @@ import meow from 'meow';
 const cli = meow(
     `
   Usage
-    $ yarn ts-node <path-to-this-file> [options]
+    $ yarn run-example <path-to-this-file> [options]
 
   Required
     --peer, -p  The ip of the peer to ban.

diff --git a/examples/client/dumpStart.ts b/examples/client/dumpStart.ts
@@ -6,7 +6,7 @@ import meow from 'meow';
 const cli = meow(
     `
   Usage
-    $ yarn ts-node <path-to-this-file> [options]
+    $ yarn run-example <path-to-this-file> [options]
 
   Required
     --filepath, -f  Specifies which file to dump the packages into

diff --git a/examples/client/dumpStop.ts b/examples/client/dumpStop.ts
@@ -6,7 +6,7 @@ import meow from 'meow';
 const cli = meow(
     `
   Usage
-    $ yarn ts-node <path-to-this-file> [options]
+    $ yarn run-example <path-to-this-file> [options]
 
   Options
     --help,         Displays this message

diff --git a/examples/client/getAccountList.ts b/examples/client/getAccountList.ts
@@ -6,7 +6,7 @@ import meow from 'meow';
 const cli = meow(
     `
   Usage
-    $ yarn ts-node <path-to-this-file> [options]
+    $ yarn run-example <path-to-this-file> [options]
 
   Options
     --help,         Displays this message

diff --git a/examples/client/getAccountNonFinalizedTransactions.ts b/examples/client/getAccountNonFinalizedTransactions.ts
@@ -10,7 +10,7 @@ import meow from 'meow';
 const cli = meow(
     `
   Usage
-    $ yarn ts-node <path-to-this-file> [options]
+    $ yarn run-example <path-to-this-file> [options]
 
   Required
     --account, -a  The account to get transactions from

diff --git a/examples/client/getAncestors.ts b/examples/client/getAncestors.ts
@@ -6,7 +6,7 @@ import meow from 'meow';
 const cli = meow(
     `
   Usage
-    $ yarn ts-node <path-to-this-file> [options]
+    $ yarn run-example <path-to-this-file> [options]
 
   Required
     --max-ancestors, -m  Maximum amount of ancestors to get

diff --git a/examples/client/getAnonymityRevokers.ts b/examples/client/getAnonymityRevokers.ts
@@ -6,7 +6,7 @@ import meow from 'meow';
 const cli = meow(
     `
   Usage
-    $ yarn ts-node <path-to-this-file> [options]
+    $ yarn run-example <path-to-this-file> [options]
 
   Options
     --help,         Displays this message

diff --git a/examples/client/getBakerList.ts b/examples/client/getBakerList.ts
@@ -6,7 +6,7 @@ import meow from 'meow';
 const cli = meow(
     `
   Usage
-    $ yarn ts-node <path-to-this-file> [options]
+    $ yarn run-example <path-to-this-file> [options]
 
   Options
     --help,         Displays this message

diff --git a/examples/client/getBannedPeers.ts b/examples/client/getBannedPeers.ts
@@ -6,8 +6,7 @@ import meow from 'meow';
 const cli = meow(
     `
   Usage
-    $ yarn ts-node <path-to-this-file> [options]
-
+    $ yarn run-example <path-to-this-file> [options]
 
   Options
     --help,         Displays this message

diff --git a/examples/client/getBlockChainParameters.ts b/examples/client/getBlockChainParameters.ts
@@ -10,8 +10,7 @@ import meow from 'meow';
 const cli = meow(
     `
   Usage
-    $ yarn ts-node <path-to-this-file> [options]
-
+    $ yarn run-example <path-to-this-file> [options]
 
   Options
     --help,         Displays this message

diff --git a/examples/client/getBlockFinalizationSummary.ts b/examples/client/getBlockFinalizationSummary.ts
@@ -9,7 +9,7 @@ import meow from 'meow';
 const cli = meow(
     `
   Usage
-    $ yarn ts-node <path-to-this-file> [options]
+    $ yarn run-example <path-to-this-file> [options]
 
   Options
     --help,         Displays this message

diff --git a/examples/client/getBlockInfo.ts b/examples/client/getBlockInfo.ts
@@ -6,7 +6,7 @@ import meow from 'meow';
 const cli = meow(
     `
   Usage
-    $ yarn ts-node <path-to-this-file> [options]
+    $ yarn run-example <path-to-this-file> [options]
 
   Options
     --help,         Displays this message

diff --git a/examples/client/getBlockPendingUpdates.ts b/examples/client/getBlockPendingUpdates.ts
@@ -6,7 +6,7 @@ import meow from 'meow';
 const cli = meow(
     `
   Usage
-    $ yarn ts-node <path-to-this-file> [options]
+    $ yarn run-example <path-to-this-file> [options]
 
   Options
     --help,         Displays this message

diff --git a/examples/client/getBlockSpecialEvents.ts b/examples/client/getBlockSpecialEvents.ts
@@ -9,7 +9,7 @@ import meow from 'meow';
 const cli = meow(
     `
   Usage
-    $ yarn ts-node <path-to-this-file> [options]
+    $ yarn run-example <path-to-this-file> [options]
 
   Options
     --help,         Displays this message

diff --git a/examples/client/getBlockTransactionEvents.ts b/examples/client/getBlockTransactionEvents.ts
@@ -6,7 +6,7 @@ import meow from 'meow';
 const cli = meow(
     `
   Usage
-    $ yarn ts-node <path-to-this-file> [options]
+    $ yarn run-example <path-to-this-file> [options]
 
   Options
     --help,         Displays this message

diff --git a/examples/client/getBlocks.ts b/examples/client/getBlocks.ts
@@ -6,7 +6,7 @@ import meow from 'meow';
 const cli = meow(
     `
   Usage
-    $ yarn ts-node <path-to-this-file> [options]
+    $ yarn run-example <path-to-this-file> [options]
 
   Options
     --help,         Displays this message

diff --git a/examples/client/getBlocksAtHeightRelative.ts b/examples/client/getBlocksAtHeightRelative.ts
@@ -10,14 +10,14 @@ import meow from 'meow';
 const cli = meow(
     `
   Usage
-    $ yarn ts-node <path-to-this-file> [options]
+    $ yarn run-example <path-to-this-file> [options]
 
   Required
     --height,            Height starting from the genesis block at the genesis index.
     --restrict,      -r  Whether to return results only from the specified genesis index (true),
                          or allow results from more recent genesis indices as well (false).
-    --genesis-index, -g  The index of a (re)genesis block. The initial genesis block has index 0 
-                         and each subsequent regenesis has an incrementally higher index. 
+    --genesis-index, -g  The index of a (re)genesis block. The initial genesis block has index 0
+                         and each subsequent regenesis has an incrementally higher index.
 
   Options
     --help,         Displays this message.

diff --git a/examples/client/getBranches.ts b/examples/client/getBranches.ts
@@ -6,7 +6,7 @@ import meow from 'meow';
 const cli = meow(
     `
   Usage
-    $ yarn ts-node <path-to-this-file> [options]
+    $ yarn run-example <path-to-this-file> [options]
 
   Options
     --help,         Displays this message

diff --git a/examples/client/getConsensusStatus.ts b/examples/client/getConsensusStatus.ts
@@ -6,7 +6,7 @@ import meow from 'meow';
 const cli = meow(
     `
   Usage
-    $ yarn ts-node <path-to-this-file> [options]
+    $ yarn run-example <path-to-this-file> [options]
 
   Options
     --help,         Displays this message

diff --git a/examples/readme.md b/examples/readme.md
@@ -6,7 +6,7 @@ client to interact with a Concordium node, `cis2`  containing examples that help
 run an example call:
 
 ```shell
-yarn ts-node /path/to/example.ts [opts]
+yarn run-example /path/to/example.ts [opts]
 ```
 
 Where opts are any arguments that the example script takes.