Updated docs after review

paritytech · Nov 2, 2023 · 2753b8e · 2753b8e
1 parent 0836066
commit 2753b8e
Show file tree

Hide file tree

Showing 7 changed files with 85 additions and 60 deletions.
diff --git a/README.md b/README.md
@@ -328,8 +328,8 @@ You need first to *clone* this repository and run:
 For an easier and faster setup of your local environment, run:
 
 ```bash
-❯ cd zombinet/javascript/packages
-❯ node ./cli/dist/cli.js <binaries>
+❯ cd zombinet/javascript
+❯ npm run zombie -- setup <binaries>
 ```
 
 This allows to use the `setup` script, making everything ready for a ZombieNet dev environment.
@@ -341,8 +341,8 @@ You can use the following arguments:
 For example:
 
 ```bash
-❯ cd zombinet/javascript/packages
-❯ node ./cli/dist/cli.js setup polkadot polkadot-parachain
+❯ cd zombinet/javascript
+❯ npm run zombie -- setup polkadot polkadot-parachain
 ```
 
 > Note: If you are using macOS please clone the [polkadot-sdk repo](https://github.com/paritytech/polkadot-sdk) and run it locally. At the moment there is no `polkadot` binary for MacOs.
@@ -371,21 +371,26 @@ You can build it from source like this
 With the above steps completed, the `zombienet` CLI is ready to run:
 
 ```bash
-❯ cd zombinet/javascript/packages
-❯ node ./cli/dist/cli.js
+❯ cd zombinet/javascript
+❯ npm run zombie
 
 Usage: zombienet [options] [command]
 
 Options:
-  -p, --provider <provider>                Override provider to use (choices: "podman",
-                                           "kubernetes", default: kubernetes)
+  -c, --spawn-concurrency <concurrency>    Number of concurrent spawning process to launch, default is 1
+  -p, --provider <provider>                Override provider to use (choices: "podman", "kubernetes", "native")
+  -l, --logType <logType>                  Type of logging - defaults to 'table' (choices: "table", "text", "silent")
+  -d, --dir <path>                         Directory path for placing the network files instead of random temp one 
+                                           (e.g. -d /home/user/my-zombienet)
+  -f, --force                              Force override all prompt commands
   -h, --help                               display help for command
 
 Commands:
-  spawn <networkConfig> [creds] [monitor]  Spawn the network defined in the config
-  test <testFile>                          Run tests on the network defined
+  spawn [options] <networkConfig> [creds]  Spawn the network defined in the config
+  test <testFile> [runningNetworkSpec]     Run tests on the network defined
+  setup [options] <binaries...>            Setup is meant for downloading and making dev environment of ZombieNet ready
+  convert <filePath>                       Convert is meant for transforming a (now deprecated) polkadot-launch configuration to zombienet configuration
   version                                  Prints zombienet version
-  setup                                    Runs the setup of local environment
   help [command]                           display help for command
 ```
 

diff --git a/docs/book/searchindex.js b/docs/book/searchindex.js
@@ -287,7 +287,7 @@ Object.assign(window.search, {
           title: "Download and install needed artifacts (optional)",
         },
         38: {
-          body: 'With the above steps completed, the zombienet CLI is ready to run: cd zombinet/javascript && npm run zombie -- Usage: zombienet [options] [command] Options: -p, --provider <provider> Override provider to use (choices: "podman", "kubernetes", default: kubernetes) -h, --help display help for command Commands: spawn <networkConfig> [creds] [monitor] Spawn the network defined in the config test <testFile> Run tests on the network defined version Prints zombienet version help [command] display help for command',
+          body: 'With the above steps completed, the zombienet CLI is ready to run: cd zombinet/javascript && npm run zombie -- Usage: zombienet [options] [command] Options: -c, --spawn-concurrency <concurrency> Number of concurrent spawning process to launch, default is 1 -p, --provider <provider> Override provider to use (choices: "podman", "kubernetes", "native") -l, --logType <logType> Type of logging - defaults to "table" (choices: "table", "text", "silent") -d, --dir <path> Directory path for placing the network files instead of random temp one -f, --force Force override all prompt commands -h, --help display help for command Commands: spawn [options] <networkConfig> [creds]  Spawn the network defined in the config test <testFile> [runningNetworkSpec] Run tests on the network defined setup [options] <binaries...>  Setup is meant for downloading and making dev environment of ZombieNet ready convert <filePath> Convert is meant for transforming a (now deprecated) polkadot-launch configuration to zombienet configuration version Prints zombienet version help [command] display help for command',
           breadcrumbs: "Development » Using Zombienet",
           id: "38",
           title: "Using Zombienet",

diff --git a/docs/book/searchindex.json b/docs/book/searchindex.json
@@ -273,13 +273,13 @@
           "title": "Installation"
         },
         "37": {
-          "body": "For an easier and faster setup of your local environment, run: cd zombinet/javascript/packages && node ./cli/dist/cli.js setup <binaries> This allows to use the setup script, making everything ready for a ZombieNet dev environment. You can use the following arguments: --help shows the different options and commands for using the Zombienet CLI. --binaries or -b: enables providing the binaries that you want to be downloaded and installed during the setup. Possible options: polkadot, polkadot-parachain. For example: cd zombinet/javascript/packages && node ./cli/dist/cli.js setup polkadot polkadot-parachain Note: If you are using macOS please clone the polkadot-sdk repo and run it locally. At the moment there is no polkadot binary for MacOs. The command above will retrieve the binaries provided and try to download and prepare those binaries for usage. At the end of the download, the setup script will provide a command to run in your local environment in order to add the directory where the binaries were downloaded in your $PATH var, for example: Please add the dir to your $PATH by running the command: export PATH=/home/<user>/current_directory:$PATH",
+          "body": "For an easier and faster setup of your local environment, run: cd zombinet/javascript && npm run zombie -- setup <binaries> This allows to use the setup script, making everything ready for a ZombieNet dev environment. You can use the following arguments: --help shows the different options and commands for using the Zombienet CLI. --binaries or -b: enables providing the binaries that you want to be downloaded and installed during the setup. Possible options: polkadot, polkadot-parachain. For example: cd zombinet/javascript && npm run zombie -- setup polkadot polkadot-parachain Note: If you are using macOS please clone the polkadot-sdk repo and run it locally. At the moment there is no polkadot binary for MacOs. The command above will retrieve the binaries provided and try to download and prepare those binaries for usage. At the end of the download, the setup script will provide a command to run in your local environment in order to add the directory where the binaries were downloaded in your $PATH var, for example: Please add the dir to your $PATH by running the command: export PATH=/home/<user>/current_directory:$PATH",
           "breadcrumbs": "Development » Download and install needed artifacts (optional)",
           "id": "37",
           "title": "Download and install needed artifacts (optional)"
         },
         "38": {
-          "body": "With the above steps completed, the zombienet CLI is ready to run: cd zombinet/javascript/packages && node ./cli/dist/cli.js Usage: zombienet [options] [command] Options: -p, --provider <provider> Override provider to use (choices: \"podman\", \"kubernetes\", default: kubernetes) -h, --help display help for command Commands: spawn <networkConfig> [creds] [monitor] Spawn the network defined in the config test <testFile> Run tests on the network defined version Prints zombienet version help [command] display help for command",
+          "body": "With the above steps completed, the zombienet CLI is ready to run: cd zombinet/javascript && npm run zombie -- Usage: zombienet [options] [command] Options: -c, --spawn-concurrency <concurrency> Number of concurrent spawning process to launch, default is 1 -p, --provider <provider> Override provider to use (choices: 'podman', 'kubernetes', 'native') -l, --logType <logType> Type of logging - defaults to 'table' (choices: 'table', 'text', 'silent') -d, --dir <path> Directory path for placing the network files instead of random temp one -f, --force Force override all prompt commands -h, --help display help for command Commands: spawn [options] <networkConfig> [creds]  Spawn the network defined in the config test <testFile> [runningNetworkSpec] Run tests on the network defined setup [options] <binaries...>  Setup is meant for downloading and making dev environment of ZombieNet ready convert <filePath> Convert is meant for transforming a (now deprecated) polkadot-launch configuration to zombienet configuration version Prints zombienet version help [command] display help for command",
           "breadcrumbs": "Development » Using Zombienet",
           "id": "38",
           "title": "Using Zombienet"

diff --git a/docs/src/development.md b/docs/src/development.md
@@ -22,8 +22,8 @@ You need to first _clone_ this repository and run:
 For an easier and faster setup of your local environment, run:
 
 ```bash
-❯ cd zombinet/javascript/packages
-❯ node ./cli/dist/cli.js <binaries>
+❯ cd zombinet/javascript
+❯ npm run zombie -- setup <binaries>
 ```
 
 This allows to use the `setup` script, making everything ready for a ZombieNet dev environment.
@@ -36,8 +36,8 @@ You can use the following arguments:
 For example:
 
 ```bash
-❯ cd zombinet/javascript/packages
-❯ node ./cli/dist/cli.js setup polkadot polkadot-parachain
+❯ cd zombinet/javascript
+❯ npm run zombie -- setup polkadot polkadot-parachain
 ```
 
 > Note: If you are using macOS please clone the [polkadot-sdk repo](https://github.com/paritytech/polkadot-sdk) and run it locally. At the moment there is no `polkadot` binary for MacOs.
@@ -64,20 +64,25 @@ nix run nixpkgs#prefetch-npm-deps -- javascript/package-lock.json 2>/dev/null
 With the above steps completed, the `zombienet` CLI is ready to run:
 
 ```bash
-❯ cd zombinet/javascript/packages
-❯ node ./cli/dist/cli.js
+❯ cd zombinet/javascript
+❯ npm run zombie
 
 Usage: zombienet [options] [command]
 
 Options:
-  -p, --provider <provider>                Override provider to use (choices: "podman",
-                                           "kubernetes", default: kubernetes)
+  -c, --spawn-concurrency <concurrency>    Number of concurrent spawning process to launch, default is 1
+  -p, --provider <provider>                Override provider to use (choices: "podman", "kubernetes", "native")
+  -l, --logType <logType>                  Type of logging - defaults to 'table' (choices: "table", "text", "silent")
+  -d, --dir <path>                         Directory path for placing the network files instead of random temp one 
+                                           (e.g. -d /home/user/my-zombienet)
+  -f, --force                              Force override all prompt commands
   -h, --help                               display help for command
 
 Commands:
-  spawn <networkConfig> [creds] [monitor]  Spawn the network defined in the config
-  test <testFile>                          Run tests on the network defined
+  spawn [options] <networkConfig> [creds]  Spawn the network defined in the config
+  test <testFile> [runningNetworkSpec]     Run tests on the network defined
+  setup [options] <binaries...>            Setup is meant for downloading and making dev environment of ZombieNet ready
+  convert <filePath>                       Convert is meant for transforming a (now deprecated) polkadot-launch configuration to zombienet configuration
   version                                  Prints zombienet version
-  setup                                    Runs the setup of local environment
   help [command]                           display help for command
 ```
diff --git a/javascript/README.md b/javascript/README.md
@@ -324,8 +324,8 @@ You need first to *clone* this repository and run:
 For an easier and faster setup of your local environment, run:
 
 ```bash
-❯ cd zombinet/javascript/packages
-❯ node ./cli/dist/cli.js setup <binaries>
+❯ cd zombinet/javascript
+❯ npm run zombie -- setup <binaries>
 ```
 
 This allows to use the `setup` script, making everything ready for a ZombieNet dev environment.
@@ -338,8 +338,8 @@ You can use the following arguments:
 For example:
 
 ```bash
-❯ cd zombinet/javascript/packages
-❯ node ./cli/dist/cli.js setup polkadot polkadot-parachain
+❯ cd zombinet/javascript
+❯ npm run zombie -- setup polkadot polkadot-parachain
 ```
 
 > Note: If you are using macOS please clone the [polkadot-sdk repo](https://github.com/paritytech/polkadot-sdk) and run it locally. At the moment there is no `polkadot` binary for MacOs.
@@ -357,7 +357,7 @@ You can build it from source like this
 
 ```bash
 ❯ git clone git@github.com:paritytech/polkadot-sdk.git
-❯ cd polkadot-sdk/polkadot
+❯ cd polkadot-sdk
 cargo build --profile testnet -p test-parachain-adder-collator
 export PATH=$(pwd)/target/testnet:$PATH
 ```
@@ -368,21 +368,26 @@ export PATH=$(pwd)/target/testnet:$PATH
 With the above steps completed, the `zombienet` CLI is ready to run:
 
 ```bash
-❯ cd zombinet/javascript/packages
-❯ node ./cli/dist/cli.js
+❯ cd zombinet/javascript
+❯ npm run zombie
 
 Usage: zombienet [options] [command]
 
 Options:
-  -p, --provider <provider>                Override provider to use (choices: "podman",
-                                           "kubernetes", default: kubernetes)
+  -c, --spawn-concurrency <concurrency>    Number of concurrent spawning process to launch, default is 1
+  -p, --provider <provider>                Override provider to use (choices: "podman", "kubernetes", "native")
+  -l, --logType <logType>                  Type of logging - defaults to 'table' (choices: "table", "text", "silent")
+  -d, --dir <path>                         Directory path for placing the network files instead of random temp one 
+                                           (e.g. -d /home/user/my-zombienet)
+  -f, --force                              Force override all prompt commands
   -h, --help                               display help for command
 
 Commands:
-  spawn <networkConfig> [creds] [monitor]  Spawn the network defined in the config
-  test <testFile>                          Run tests on the network defined
+  spawn [options] <networkConfig> [creds]  Spawn the network defined in the config
+  test <testFile> [runningNetworkSpec]     Run tests on the network defined
+  setup [options] <binaries...>            Setup is meant for downloading and making dev environment of ZombieNet ready
+  convert <filePath>                       Convert is meant for transforming a (now deprecated) polkadot-launch configuration to zombienet configuration
   version                                  Prints zombienet version
-  setup                                    Runs the setup of local environment
   help [command]                           display help for command
 ```
 

diff --git a/javascript/packages/cli/README.md b/javascript/packages/cli/README.md
@@ -325,8 +325,8 @@ You need first to *clone* this repository and run:
 For an easier and faster setup of your local environment, run:
 
 ```bash
-❯ cd zombinet/javascript/packages
-❯ node ./cli/dist/cli.js setup <binaries>
+❯ cd zombinet/javascript
+❯ npm run zombie -- setup <binaries>
 ```
 
 This allows to use the `setup` script, making everything ready for a ZombieNet dev environment.
@@ -339,8 +339,8 @@ You can use the following arguments:
 For example:
 
 ```bash
-❯ cd zombinet/javascript/packages
-❯ node ./cli/dist/cli.js setup polkadot polkadot-parachain
+❯ cd zombinet/javascript
+❯ npm run zombie -- setup polkadot polkadot-parachain
 ```
 
 > Note: If you are using macOS please clone the [polkadot-sdk repo](https://github.com/paritytech/polkadot-sdk) and run it locally. At the moment there is no `polkadot` binary for MacOs.
@@ -369,21 +369,26 @@ export PATH=$(pwd)/target/testnet:$PATH
 With the above steps completed, the `zombienet` CLI is ready to run:
 
 ```bash
-❯ cd zombinet/javascript/packages
-❯ node ./cli/dist/cli.js
+❯ cd zombinet/javascript
+❯ npm run zombie
 
 Usage: zombienet [options] [command]
 
 Options:
-  -p, --provider <provider>                Override provider to use (choices: "podman",
-                                           "kubernetes", default: kubernetes)
+  -c, --spawn-concurrency <concurrency>    Number of concurrent spawning process to launch, default is 1
+  -p, --provider <provider>                Override provider to use (choices: "podman", "kubernetes", "native")
+  -l, --logType <logType>                  Type of logging - defaults to 'table' (choices: "table", "text", "silent")
+  -d, --dir <path>                         Directory path for placing the network files instead of random temp one 
+                                           (e.g. -d /home/user/my-zombienet)
+  -f, --force                              Force override all prompt commands
   -h, --help                               display help for command
 
 Commands:
-  spawn <networkConfig> [creds] [monitor]  Spawn the network defined in the config
-  test <testFile>                          Run tests on the network defined
+  spawn [options] <networkConfig> [creds]  Spawn the network defined in the config
+  test <testFile> [runningNetworkSpec]     Run tests on the network defined
+  setup [options] <binaries...>            Setup is meant for downloading and making dev environment of ZombieNet ready
+  convert <filePath>                       Convert is meant for transforming a (now deprecated) polkadot-launch configuration to zombienet configuration
   version                                  Prints zombienet version
-  setup                                    Runs the setup of local environment
   help [command]                           display help for command
 ```