{"version":"1.1.10","commands":{"clean":{"id":"clean","description":"It removes the target folder deleting the generated configuration and data","pluginName":"twix-bootstrap","pluginType":"core","aliases":[],"examples":["$ twix-bootstrap clean"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"It shows the help of this command.","allowNo":false},"target":{"name":"target","type":"option","char":"t","description":"The target folder where the twix-bootstrap network is generated","default":"target"},"logger":{"name":"logger","type":"option","description":"The loggers the command will use. Options are: Console,File,Silent. Use ',' to select multiple loggers.","default":"Console,File"}},"args":[]},"compose":{"id":"compose","description":"It generates the `docker-compose.yml` file from the configured network.","pluginName":"twix-bootstrap","pluginType":"core","aliases":[],"examples":["$ twix-bootstrap compose"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"It shows the help of this command.","allowNo":false},"target":{"name":"target","type":"option","char":"t","description":"The target folder where the twix-bootstrap network is generated","default":"target"},"password":{"name":"password","type":"option","description":"A password used to encrypt and decrypt private keys in preset files like addresses.yml and preset.yml. Bootstrap prompts for a password by default, can be provided in the command line (--password=XXXX) or disabled in the command line (--noPassword)."},"noPassword":{"name":"noPassword","type":"boolean","description":"When provided, Bootstrap will not use a password, so private keys will be stored in plain text. Use with caution.","allowNo":false},"upgrade":{"name":"upgrade","type":"boolean","description":"It regenerates the docker compose and utility files from the <target>/docker folder","allowNo":false},"offline":{"name":"offline","type":"boolean","description":"If --offline is used, Bootstrap resolves the configuration without querying the running network.","allowNo":false},"user":{"name":"user","type":"option","char":"u","description":"User used to run the services in the docker-compose.yml file. \"current\" means the current user.","default":"current"},"logger":{"name":"logger","type":"option","description":"The loggers the command will use. Options are: Console,File,Silent. Use ',' to select multiple loggers.","default":"Console,File"}},"args":[]},"config":{"id":"config","description":"Command used to set up the configuration files and the nemesis block for the current network","pluginName":"twix-bootstrap","pluginType":"core","aliases":[],"examples":["$ twix-bootstrap config -p bootstrap","$ twix-bootstrap config -p testnet -a dual --password 1234","$ twix-bootstrap config -p mainnet -a peer -c custom-preset.yml","$ twix-bootstrap config -p mainnet -a my-custom-assembly.yml -c custom-preset.yml","$ twix-bootstrap config -p my-custom-network.yml -a dual -c custom-preset.yml","$ echo \"$MY_ENV_VAR_PASSWORD\" | twix-bootstrap config -p testnet -a dual"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"It shows the help of this command.","allowNo":false},"target":{"name":"target","type":"option","char":"t","description":"The target folder where the twix-bootstrap network is generated","default":"target"},"password":{"name":"password","type":"option","description":"A password used to encrypt and decrypt private keys in preset files like addresses.yml and preset.yml. Bootstrap prompts for a password by default, can be provided in the command line (--password=XXXX) or disabled in the command line (--noPassword)."},"noPassword":{"name":"noPassword","type":"boolean","description":"When provided, Bootstrap will not use a password, so private keys will be stored in plain text. Use with caution.","allowNo":false},"preset":{"name":"preset","type":"option","char":"p","description":"The network preset. It can be provided via custom preset or cli parameter. If not provided, the value is resolved from the target/preset.yml file. Options are: bootstrap, testnet, mainnet, my-custom-network.yml (advanced, only for custom networks)."},"assembly":{"name":"assembly","type":"option","char":"a","description":"The assembly that defines the node(s) layout. It can be provided via custom preset or cli parameter. If not provided, the value is resolved from the target/preset.yml file. Options are: dual, peer, api, demo, multinode, services, my-custom-assembly.yml (advanced)."},"customPreset":{"name":"customPreset","type":"option","char":"c","description":"External preset file. Values in this file will override the provided presets."},"reset":{"name":"reset","type":"boolean","char":"r","description":"It resets the configuration generating a new one.","allowNo":false},"upgrade":{"name":"upgrade","type":"boolean","description":"It regenerates the configuration reusing the previous keys. Use this flag when upgrading the version of bootstrap to keep your node up to date without dropping the local data. Backup the target folder before upgrading.","allowNo":false},"offline":{"name":"offline","type":"boolean","description":"If --offline is used, Bootstrap resolves the configuration without querying the running network.","allowNo":false},"report":{"name":"report","type":"boolean","description":"It generates reStructuredText (.rst) reports describing the configuration of each node.","allowNo":false},"user":{"name":"user","type":"option","char":"u","description":"User used to run docker images when creating configuration files like certificates or nemesis block. \"current\" means the current user.","default":"current"},"logger":{"name":"logger","type":"option","description":"The loggers the command will use. Options are: Console,File,Silent. Use ',' to select multiple loggers.","default":"Console,File"}},"args":[]},"decrypt":{"id":"decrypt","description":"It decrypts a yml file using the provided password. The source file can be a custom preset file, a preset.yml file or an addresses.yml.\n\nThe main use case of this command is to verify private keys in encrypted files after encrypting a custom preset or running a bootstrap command with a provided --password.","pluginName":"twix-bootstrap","pluginType":"core","aliases":[],"examples":["\n$ twix-bootstrap start --password 1234 --preset testnet --assembly dual --customPreset decrypted-custom-preset.yml --detached\n$ twix-bootstrap decrypt --password 1234 --source target/addresses.yml --destination plain-addresses.yml\n$ twix-bootstrap decrypt --password 1234 --source encrypted-custom-preset.yml --destination plain-custom-preset.yml\n$ cat plain-addresses.yml\n$ cat plain-custom-preset.yml\n$ rm plain-addresses.yml\n$ rm plain-custom-preset.yml\n        ","\n$ twix-bootstrap start --preset testnet --assembly dual --customPreset decrypted-custom-preset.yml --detached\n> password prompt\n$ twix-bootstrap decrypt --source target/addresses.yml --destination plain-addresses.yml\n> password prompt (enter the same password)\n$ twix-bootstrap decrypt --source encrypted-custom-preset.yml --destination plain-custom-preset.yml\n> password prompt (enter the same password)\n$ cat plain-addresses.yml\n$ cat plain-custom-preset.yml\n$ rm plain-addresses.yml\n$ rm plain-custom-preset.yml","\n$ echo \"$MY_ENV_VAR_PASSWORD\" | twix-bootstrap decrypt --source target/addresses.yml --destination plain-addresses.yml\n"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"It shows the help of this command.","allowNo":false},"source":{"name":"source","type":"option","description":"The source encrypted yml file to be decrypted.","required":true},"destination":{"name":"destination","type":"option","description":"The destination decrypted file to create. The destination file must not exist.","required":true},"password":{"name":"password","type":"option","description":"The password to use to decrypt the source file into the destination file. Bootstrap prompts for a password by default, can be provided in the command line (--password=XXXX) or disabled in the command line (--noPassword)."},"logger":{"name":"logger","type":"option","description":"The loggers the command will use. Options are: Console,File,Silent. Use ',' to select multiple loggers.","default":"Console"}},"args":[]},"encrypt":{"id":"encrypt","description":"It encrypts a yml file using the provided password. The source files would be a custom preset file, a preset.yml file or an addresses.yml.\n\nThe main use case of this command is encrypting custom presets files. If your custom preset contains private keys, it's highly recommended to encrypt it and use provide --password when starting or configuring the node with Bootstrap.","pluginName":"twix-bootstrap","pluginType":"core","aliases":[],"examples":["\n$ twix-bootstrap encrypt --source plain-custom-preset.yml --destination encrypted-custom-preset.yml\n> password prompt\n$ twix-bootstrap start --preset testnet --assembly dual --customPreset encrypted-custom-preset.yml\n> password prompt (enter the same password)\n        ","\n$ twix-bootstrap encrypt --password 1234 --source plain-custom-preset.yml --destination encrypted-custom-preset.yml\n$ twix-bootstrap start --password 1234 --preset testnet --assembly dual --customPreset encrypted-custom-preset.yml\n","\n $ echo \"$MY_ENV_VAR_PASSWORD\" | twix-bootstrap encrypt --source plain-custom-preset.yml --destination encrypted-custom-preset.yml\n "],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"It shows the help of this command.","allowNo":false},"source":{"name":"source","type":"option","description":"The source plain yml file to be encrypted. If this file is encrypted, the command will raise an error.","required":true},"destination":{"name":"destination","type":"option","description":"The destination encrypted file to create. The destination file must not exist.","required":true},"password":{"name":"password","type":"option","description":"The password to use to encrypt the source file into the destination file. Bootstrap prompts for a password by default, can be provided in the command line (--password=XXXX) or disabled in the command line (--noPassword)."},"logger":{"name":"logger","type":"option","description":"The loggers the command will use. Options are: Console,File,Silent. Use ',' to select multiple loggers.","default":"Console"}},"args":[]},"healthCheck":{"id":"healthCheck","description":"It checks if the services created with docker compose are up and running.\n\nThis command checks:\n- Whether the docker containers are running.\n- Whether the services' exposed ports are listening.\n- Whether the rest gateways' /node/health are OK.\n\nThe health check process handles 'repeat' and custom 'openPort' services.\n    ","pluginName":"twix-bootstrap","pluginType":"core","aliases":[],"examples":["$ twix-bootstrap healthCheck"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"It shows the help of this command.","allowNo":false},"target":{"name":"target","type":"option","char":"t","description":"The target folder where the twix-bootstrap network is generated","default":"target"},"logger":{"name":"logger","type":"option","description":"The loggers the command will use. Options are: Console,File,Silent. Use ',' to select multiple loggers.","default":"Console,File"}},"args":[]},"link":{"id":"link","description":"It announces VRF and Voting Link transactions to the network for each node with 'Peer' or 'Voting' roles. This command finalizes the node registration to an existing network.","pluginName":"twix-bootstrap","pluginType":"core","aliases":[],"examples":["$ twix-bootstrap link","$ echo \"$MY_ENV_VAR_PASSWORD\" | twix-bootstrap link --unlink --useKnownRestGateways"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"It shows the help of this command.","allowNo":false},"target":{"name":"target","type":"option","char":"t","description":"The target folder where the twix-bootstrap network is generated","default":"target"},"unlink":{"name":"unlink","type":"boolean","description":"Perform \"Unlink\" transactions unlinking the voting and VRF keys from the node signer account","allowNo":false},"password":{"name":"password","type":"option","description":"A password used to encrypt and decrypt private keys in preset files like addresses.yml and preset.yml. Bootstrap prompts for a password by default, can be provided in the command line (--password=XXXX) or disabled in the command line (--noPassword)."},"noPassword":{"name":"noPassword","type":"boolean","description":"When provided, Bootstrap will not use a password, so private keys will be stored in plain text. Use with caution.","allowNo":false},"url":{"name":"url","type":"option","char":"u","description":"the network url","default":"http://localhost:3000"},"useKnownRestGateways":{"name":"useKnownRestGateways","type":"boolean","description":"Use the best NEM node available when announcing. Otherwise the command will use the node provided by the --url parameter.","allowNo":false},"ready":{"name":"ready","type":"boolean","description":"If --ready is provided, the command will not ask for confirmation when announcing transactions.","allowNo":false},"maxFee":{"name":"maxFee","type":"option","description":"the max fee used when announcing (absolute). The node min multiplier will be used if it is not provided."},"customPreset":{"name":"customPreset","type":"option","char":"c","description":"This command uses the encrypted addresses.yml to resolve the main private key. If the main private is only stored in the custom preset, you can provide it using this param. Otherwise, the command may ask for it when required.","required":false},"serviceProviderPublicKey":{"name":"serviceProviderPublicKey","type":"option","description":"Public key of the service provider account, used when the transaction announcer(service provider account) is different than the main account private key holder"},"logger":{"name":"logger","type":"option","description":"The loggers the command will use. Options are: Console,File,Silent. Use ',' to select multiple loggers.","default":"Console"}},"args":[]},"modifyMultisig":{"id":"modifyMultisig","description":"Create or modify a multisig account","pluginName":"twix-bootstrap","pluginType":"core","aliases":[],"examples":["$ twix-bootstrap modifyMultisig","$ echo \"$MY_ENV_VAR_PASSWORD\" | twix-bootstrap modifyMultisig --useKnownRestGateways"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"It shows the help of this command.","allowNo":false},"target":{"name":"target","type":"option","char":"t","description":"The target folder where the twix-bootstrap network is generated","default":"target"},"minRemovalDelta":{"name":"minRemovalDelta","type":"option","char":"r","description":"Delta of signatures needed to remove a cosignatory. 0 means no change, a positive(+) number means increment and a negative(-) number means decrement to the actual value."},"minApprovalDelta":{"name":"minApprovalDelta","type":"option","char":"a","description":"Delta of signatures needed to approve a transaction. 0 means no change, a positive(+) number means increment and a negative(-) number means decrement to the actual value."},"addressAdditions":{"name":"addressAdditions","type":"option","char":"A","description":"Cosignatory accounts addresses to be added (separated by a comma)."},"addressDeletions":{"name":"addressDeletions","type":"option","char":"D","description":"Cosignatory accounts addresses to be removed (separated by a comma)."},"password":{"name":"password","type":"option","description":"A password used to encrypt and decrypt private keys in preset files like addresses.yml and preset.yml. Bootstrap prompts for a password by default, can be provided in the command line (--password=XXXX) or disabled in the command line (--noPassword)."},"noPassword":{"name":"noPassword","type":"boolean","description":"When provided, Bootstrap will not use a password, so private keys will be stored in plain text. Use with caution.","allowNo":false},"url":{"name":"url","type":"option","char":"u","description":"the network url","default":"http://localhost:3000"},"useKnownRestGateways":{"name":"useKnownRestGateways","type":"boolean","description":"Use the best NEM node available when announcing. Otherwise the command will use the node provided by the --url parameter.","allowNo":false},"ready":{"name":"ready","type":"boolean","description":"If --ready is provided, the command will not ask for confirmation when announcing transactions.","allowNo":false},"maxFee":{"name":"maxFee","type":"option","description":"the max fee used when announcing (absolute). The node min multiplier will be used if it is not provided."},"customPreset":{"name":"customPreset","type":"option","char":"c","description":"This command uses the encrypted addresses.yml to resolve the main private key. If the main private is only stored in the custom preset, you can provide it using this param. Otherwise, the command may ask for it when required.","required":false},"serviceProviderPublicKey":{"name":"serviceProviderPublicKey","type":"option","description":"Public key of the service provider account, used when the transaction announcer(service provider account) is different than the main account private key holder"},"logger":{"name":"logger","type":"option","description":"The loggers the command will use. Options are: Console,File,Silent. Use ',' to select multiple loggers.","default":"Console"}},"args":[]},"pack":{"id":"pack","description":"It configures and packages your node into a zip file that can be uploaded to the final node machine.","pluginName":"twix-bootstrap","pluginType":"core","aliases":[],"examples":["$ twix-bootstrap pack","$ twix-bootstrap pack -c custom-preset.yml","$ twix-bootstrap pack -p testnet -a dual -c custom-preset.yml","$ twix-bootstrap pack -p mainnet -a dual --password 1234 -c custom-preset.yml","$ echo \"$MY_ENV_VAR_PASSWORD\" | twix-bootstrap pack -c custom-preset.yml"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"It shows the help of this command.","allowNo":false},"target":{"name":"target","type":"option","char":"t","description":"The target folder where the twix-bootstrap network is generated","default":"target"},"password":{"name":"password","type":"option","description":"A password used to encrypt and decrypt private keys in preset files like addresses.yml and preset.yml. Bootstrap prompts for a password by default, can be provided in the command line (--password=XXXX) or disabled in the command line (--noPassword)."},"noPassword":{"name":"noPassword","type":"boolean","description":"When provided, Bootstrap will not use a password, so private keys will be stored in plain text. Use with caution.","allowNo":false},"upgrade":{"name":"upgrade","type":"boolean","description":"It regenerates the configuration reusing the previous keys. Use this flag when upgrading the version of bootstrap to keep your node up to date without dropping the local data. Backup the target folder before upgrading.","allowNo":false},"offline":{"name":"offline","type":"boolean","description":"If --offline is used, Bootstrap resolves the configuration without querying the running network.","allowNo":false},"user":{"name":"user","type":"option","char":"u","description":"User used to run docker images when creating configuration files like certificates or nemesis block. \"current\" means the current user.","default":"current"},"logger":{"name":"logger","type":"option","description":"The loggers the command will use. Options are: Console,File,Silent. Use ',' to select multiple loggers.","default":"Console"},"preset":{"name":"preset","type":"option","char":"p","description":"The network preset. It can be provided via custom preset or cli parameter. If not provided, the value is resolved from the target/preset.yml file. Options are: bootstrap, testnet, mainnet, my-custom-network.yml (advanced, only for custom networks)."},"assembly":{"name":"assembly","type":"option","char":"a","description":"The assembly that defines the node(s) layout. It can be provided via custom preset or cli parameter. If not provided, the value is resolved from the target/preset.yml file. Options are: dual, peer, api, demo, multinode, services, my-custom-assembly.yml (advanced)."},"customPreset":{"name":"customPreset","type":"option","char":"c","description":"External preset file. Values in this file will override the provided presets."},"reset":{"name":"reset","type":"boolean","char":"r","description":"It resets the configuration generating a new one.","allowNo":false},"report":{"name":"report","type":"boolean","description":"It generates reStructuredText (.rst) reports describing the configuration of each node.","allowNo":false},"ready":{"name":"ready","type":"boolean","description":"If --ready is provided, the command will not ask offline confirmation.","allowNo":false}},"args":[]},"renewCertificates":{"id":"renewCertificates","description":"It renews the SSL certificates of the node regenerating the node.csr.pem files but reusing the current private keys.\n\nThe certificates are only regenerated when they are closed to expiration (30 days). If you want to renew anyway, use the --force param.\n\nThis command does not change the node private key (yet). This change would require a harvesters.dat migration and relinking the node key.\n\nIt's recommended to backup the target folder before running this operation!\n","pluginName":"twix-bootstrap","pluginType":"core","aliases":[],"examples":["$ twix-bootstrap renewCertificates"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"It shows the help of this command.","allowNo":false},"target":{"name":"target","type":"option","char":"t","description":"The target folder where the twix-bootstrap network is generated","default":"target"},"password":{"name":"password","type":"option","description":"A password used to encrypt and decrypt private keys in preset files like addresses.yml and preset.yml. Bootstrap prompts for a password by default, can be provided in the command line (--password=XXXX) or disabled in the command line (--noPassword)."},"noPassword":{"name":"noPassword","type":"boolean","description":"When provided, Bootstrap will not use a password, so private keys will be stored in plain text. Use with caution.","allowNo":false},"customPreset":{"name":"customPreset","type":"option","char":"c","description":"This command uses the encrypted addresses.yml to resolve the main and transport private key. If the main and transport privates are only stored in the custom preset, you can provide them using this param. Otherwise, the command may ask for them when required.","required":false},"user":{"name":"user","type":"option","char":"u","description":"User used to run docker images when generating the certificates. \"current\" means the current user.","default":"current"},"force":{"name":"force","type":"boolean","description":"Renew the certificates even though they are not close to expire.","allowNo":false},"logger":{"name":"logger","type":"option","description":"The loggers the command will use. Options are: Console,File,Silent. Use ',' to select multiple loggers.","default":"Console,File"}},"args":[]},"report":{"id":"report","description":"it generates reStructuredText (.rst) reports describing the configuration of each node.","pluginName":"twix-bootstrap","pluginType":"core","aliases":[],"examples":["$ twix-bootstrap report"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"It shows the help of this command.","allowNo":false},"target":{"name":"target","type":"option","char":"t","description":"The target folder where the twix-bootstrap network is generated","default":"target"},"logger":{"name":"logger","type":"option","description":"The loggers the command will use. Options are: Console,File,Silent. Use ',' to select multiple loggers.","default":"Console,File"}},"args":[]},"resetData":{"id":"resetData","description":"It removes the data keeping the generated configuration, certificates, keys and block 1.","pluginName":"twix-bootstrap","pluginType":"core","aliases":[],"examples":["$ twix-bootstrap resetData"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"It shows the help of this command.","allowNo":false},"target":{"name":"target","type":"option","char":"t","description":"The target folder where the twix-bootstrap network is generated","default":"target"},"logger":{"name":"logger","type":"option","description":"The loggers the command will use. Options are: Console,File,Silent. Use ',' to select multiple loggers.","default":"Console,File"}},"args":[]},"run":{"id":"run","description":"It boots the network via docker using the generated `docker-compose.yml` file and configuration. The config and compose methods/commands need to be called before this method. This is just a wrapper for the `docker-compose up` bash call.","pluginName":"twix-bootstrap","pluginType":"core","aliases":[],"examples":["$ twix-bootstrap run"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"It shows the help of this command.","allowNo":false},"target":{"name":"target","type":"option","char":"t","description":"The target folder where the twix-bootstrap network is generated","default":"target"},"detached":{"name":"detached","type":"boolean","char":"d","description":"If provided, docker-compose will run with -d (--detached) and this command will wait unit server is running before returning","allowNo":false},"healthCheck":{"name":"healthCheck","type":"boolean","description":"It checks if the services created with docker compose are up and running.\n\nThis command checks:\n- Whether the docker containers are running.\n- Whether the services' exposed ports are listening.\n- Whether the rest gateways' /node/health are OK.\n\nThe health check process handles 'repeat' and custom 'openPort' services.\n    ","allowNo":false},"resetData":{"name":"resetData","type":"boolean","description":"It reset the database and node data but keeps the generated configuration, keys, voting tree files and block 1","allowNo":false},"pullImages":{"name":"pullImages","type":"boolean","description":"It pulls the images from DockerHub when running the configuration. It only affects alpha/dev docker images.","allowNo":false},"args":{"name":"args","type":"option","description":"Add extra arguments to the docker-compose up command. Check out https://docs.docker.com/compose/reference/up."},"build":{"name":"build","type":"boolean","char":"b","description":"If provided, docker-compose will run with -b (--build)","allowNo":false},"timeout":{"name":"timeout","type":"option","description":"If running in detached mode, how long before timing out (in milliseconds)","default":60000},"logger":{"name":"logger","type":"option","description":"The loggers the command will use. Options are: Console,File,Silent. Use ',' to select multiple loggers.","default":"Console,File"}},"args":[]},"start":{"id":"start","description":"Single command that aggregates config, compose and run in one line!","pluginName":"twix-bootstrap","pluginType":"core","aliases":[],"examples":["$ twix-bootstrap start -p bootstrap","$ twix-bootstrap start -p testnet -a dual","$ twix-bootstrap start -p mainnet -a peer -c custom-preset.yml","$ twix-bootstrap start -p testnet -a dual --password 1234","$ twix-bootstrap start -p mainnet -a my-custom-assembly.yml -c custom-preset.yml","$ twix-bootstrap start -p my-custom-network.yml -a dual -c custom-preset.yml","$ echo \"$MY_ENV_VAR_PASSWORD\" | twix-bootstrap start -p testnet -a dual"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"It shows the help of this command.","allowNo":false},"target":{"name":"target","type":"option","char":"t","description":"The target folder where the twix-bootstrap network is generated","default":"target"},"password":{"name":"password","type":"option","description":"A password used to encrypt and decrypt private keys in preset files like addresses.yml and preset.yml. Bootstrap prompts for a password by default, can be provided in the command line (--password=XXXX) or disabled in the command line (--noPassword)."},"noPassword":{"name":"noPassword","type":"boolean","description":"When provided, Bootstrap will not use a password, so private keys will be stored in plain text. Use with caution.","allowNo":false},"upgrade":{"name":"upgrade","type":"boolean","description":"It regenerates the configuration reusing the previous keys. Use this flag when upgrading the version of bootstrap to keep your node up to date without dropping the local data. Backup the target folder before upgrading.","allowNo":false},"offline":{"name":"offline","type":"boolean","description":"If --offline is used, Bootstrap resolves the configuration without querying the running network.","allowNo":false},"user":{"name":"user","type":"option","char":"u","description":"User used to run docker images when creating configuration files like certificates or nemesis block. \"current\" means the current user.","default":"current"},"logger":{"name":"logger","type":"option","description":"The loggers the command will use. Options are: Console,File,Silent. Use ',' to select multiple loggers.","default":"Console,File"},"detached":{"name":"detached","type":"boolean","char":"d","description":"If provided, docker-compose will run with -d (--detached) and this command will wait unit server is running before returning","allowNo":false},"healthCheck":{"name":"healthCheck","type":"boolean","description":"It checks if the services created with docker compose are up and running.\n\nThis command checks:\n- Whether the docker containers are running.\n- Whether the services' exposed ports are listening.\n- Whether the rest gateways' /node/health are OK.\n\nThe health check process handles 'repeat' and custom 'openPort' services.\n    ","allowNo":false},"resetData":{"name":"resetData","type":"boolean","description":"It reset the database and node data but keeps the generated configuration, keys, voting tree files and block 1","allowNo":false},"pullImages":{"name":"pullImages","type":"boolean","description":"It pulls the images from DockerHub when running the configuration. It only affects alpha/dev docker images.","allowNo":false},"args":{"name":"args","type":"option","description":"Add extra arguments to the docker-compose up command. Check out https://docs.docker.com/compose/reference/up."},"build":{"name":"build","type":"boolean","char":"b","description":"If provided, docker-compose will run with -b (--build)","allowNo":false},"timeout":{"name":"timeout","type":"option","description":"If running in detached mode, how long before timing out (in milliseconds)","default":60000},"preset":{"name":"preset","type":"option","char":"p","description":"The network preset. It can be provided via custom preset or cli parameter. If not provided, the value is resolved from the target/preset.yml file. Options are: bootstrap, testnet, mainnet, my-custom-network.yml (advanced, only for custom networks)."},"assembly":{"name":"assembly","type":"option","char":"a","description":"The assembly that defines the node(s) layout. It can be provided via custom preset or cli parameter. If not provided, the value is resolved from the target/preset.yml file. Options are: dual, peer, api, demo, multinode, services, my-custom-assembly.yml (advanced)."},"customPreset":{"name":"customPreset","type":"option","char":"c","description":"External preset file. Values in this file will override the provided presets."},"reset":{"name":"reset","type":"boolean","char":"r","description":"It resets the configuration generating a new one.","allowNo":false},"report":{"name":"report","type":"boolean","description":"It generates reStructuredText (.rst) reports describing the configuration of each node.","allowNo":false}},"args":[]},"stop":{"id":"stop","description":"It stops the docker-compose network if running (twix-bootstrap started with --detached). This is just a wrapper for the `docker-compose down` bash call.","pluginName":"twix-bootstrap","pluginType":"core","aliases":[],"examples":["$ twix-bootstrap stop"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"It shows the help of this command.","allowNo":false},"target":{"name":"target","type":"option","char":"t","description":"The target folder where the twix-bootstrap network is generated","default":"target"},"logger":{"name":"logger","type":"option","description":"The loggers the command will use. Options are: Console,File,Silent. Use ',' to select multiple loggers.","default":"Console,File"}},"args":[]},"updateVotingKeys":{"id":"updateVotingKeys","description":"It updates the voting files containing the voting keys when required.\n\nIf the node's current voting file has an end epoch close to the current network epoch, this command will create a new 'private_key_treeX.dat' that continues the current file.\n\nBy default, bootstrap creates a new voting file once the current file reaches its last month. The current network epoch is resolved from the network or you can provide it with the `finalizationEpoch` param.\n\nWhen a new voting file is created, Bootstrap will advise running the `link` command again.\n\n","pluginName":"twix-bootstrap","pluginType":"core","aliases":[],"examples":["$ twix-bootstrap updateVotingKeys"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"It shows the help of this command.","allowNo":false},"target":{"name":"target","type":"option","char":"t","description":"The target folder where the twix-bootstrap network is generated","default":"target"},"user":{"name":"user","type":"option","char":"u","description":"User used to run docker images when creating the the voting key files. \"current\" means the current user.","default":"current"},"finalizationEpoch":{"name":"finalizationEpoch","type":"option","description":"The network's finalization epoch. It can be retrieved from the /chain/info rest endpoint. If not provided, the bootstrap known epoch is used."},"logger":{"name":"logger","type":"option","description":"The loggers the command will use. Options are: Console,File,Silent. Use ',' to select multiple loggers.","default":"Console,File"}},"args":[]},"verify":{"id":"verify","description":"It tests the installed software in the current computer reporting if there is any missing dependency, invalid version, or software related issue.","pluginName":"twix-bootstrap","pluginType":"core","aliases":[],"examples":["$ twix-bootstrap verify"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"It shows the help of this command.","allowNo":false},"logger":{"name":"logger","type":"option","description":"The loggers the command will use. Options are: Console,File,Silent. Use ',' to select multiple loggers.","default":"Console,File"}},"args":[]},"wizard":{"id":"wizard","description":"An utility command that will help you configuring node!","pluginName":"twix-bootstrap","pluginType":"core","aliases":[],"examples":["$ twix-bootstrap wizard"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"It shows the help of this command.","allowNo":false},"target":{"name":"target","type":"option","char":"t","description":"The target folder where the twix-bootstrap network is generated","default":"target"},"password":{"name":"password","type":"option","description":"A password used to encrypt and decrypt private keys in preset files like addresses.yml and preset.yml. Bootstrap prompts for a password by default, can be provided in the command line (--password=XXXX) or disabled in the command line (--noPassword)."},"noPassword":{"name":"noPassword","type":"boolean","description":"When provided, Bootstrap will not use a password, so private keys will be stored in plain text. Use with caution.","allowNo":false},"network":{"name":"network","type":"option","description":"The node or network you want to create.","options":["bootstrap","testnet","mainnet","custom"]},"customPreset":{"name":"customPreset","type":"option","char":"c","description":"The custom preset to be created.","default":"custom-preset.yml"},"ready":{"name":"ready","type":"boolean","description":"If --ready is provided, the command will not ask offline confirmation.","allowNo":false},"logger":{"name":"logger","type":"option","description":"The loggers the command will use. Options are: Console,File,Silent. Use ',' to select multiple loggers.","default":"Console"}},"args":[]}}}