{"version":"1.4.1","commands":{"clean":{"id":"clean","description":"It removes the target folder deleting the generated configuration and data","pluginName":"yourdlt","pluginType":"core","aliases":[],"examples":["$ yourdlt 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 symbol-bootstrap network is generated","default":"target"}},"args":[]},"compose":{"id":"compose","description":"It generates the `docker-compose.yml` file from the configured network.","pluginName":"yourdlt","pluginType":"core","aliases":[],"examples":["$ yourdlt 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 symbol-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},"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"}},"args":[]},"config":{"id":"config","description":"Command used to set up the configuration files and the nemesis block for the current network","pluginName":"yourdlt","pluginType":"core","aliases":[],"examples":["$ yourdlt config -p bootstrap","$ yourdlt config -p testnet -a dual --password 1234","$ echo \"$MY_ENV_VAR_PASSWORD\" | yourdlt 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 symbol-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, can be provided via custom preset or cli parameter. If not provided, the value is resolved from the target/preset.yml file.","required":false,"helpValue":"(bootstrap|light|lightPeer|testnet|mainnet|dhealth|dhealthTestnet)","options":["bootstrap","light","lightPeer","testnet","mainnet","dhealth","dhealthTestnet"]},"assembly":{"name":"assembly","type":"option","char":"a","description":"The assembly, example \"dual\" for testnet. If not provided, the value is resolved from the target/preset.yml file.","required":false},"customPreset":{"name":"customPreset","type":"option","char":"c","description":"External preset file. Values in this file will override the provided presets","required":false},"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. The original preset (-t), assembly (-a), and custom preset (-c) must be used. Backup the target folder before upgrading.","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"}},"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 yourdlt command with a provided --password.","pluginName":"yourdlt","pluginType":"core","aliases":[],"examples":["\n$ yourdlt start --password 1234 --preset testnet --assembly dual --customPreset decrypted-custom-preset.yml --detached\n$ yourdlt decrypt --password 1234 --source target/addresses.yml --destination plain-addresses.yml\n$ yourdlt 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$ yourdlt start --preset testnet --assembly dual --customPreset decrypted-custom-preset.yml --detached\n> password prompt\n$ yourdlt decrypt --source target/addresses.yml --destination plain-addresses.yml\n> password prompt (enter the same password)\n$ yourdlt 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\" | yourdlt 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)."}},"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 yourdlt.","pluginName":"yourdlt","pluginType":"core","aliases":[],"examples":["\n$ yourdlt encrypt --source plain-custom-preset.yml --destination encrypted-custom-preset.yml\n> password prompt\n$ yourdlt start --preset testnet --assembly dual --customPreset encrypted-custom-preset.yml\n> password prompt (enter the same password)\n        ","\n$ yourdlt encrypt --password 1234 --source plain-custom-preset.yml --destination encrypted-custom-preset.yml\n$ yourdlt start --password 1234 --preset testnet --assembly dual --customPreset encrypted-custom-preset.yml\n","\n $ echo \"$MY_ENV_VAR_PASSWORD\" | yourdlt 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)."}},"args":[]},"enrollRewardProgram":{"id":"enrollRewardProgram","description":"It enrols the nodes in the rewards program by announcing the enroll transaction to the registration address.  You can also use this command to update the program registration when you change the agent keys (changing the agent-ca-csr) or server host.\nCurrently, the only program that can be enrolled post-launch is 'SuperNode'.","pluginName":"yourdlt","pluginType":"core","aliases":[],"examples":["$ yourdlt enrollRewardProgram","$ yourdlt enrollRewardProgram --noPassword","$ yourdlt enrollRewardProgram --useKnownRestGateways","$ yourdlt enrollRewardProgram --password 1234 --url http://external-rest:3000","$ echo \"$MY_ENV_VAR_PASSWORD\" | yourdlt enrollRewardProgram --url http://external-rest:3000"],"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 symbol-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},"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}},"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":"yourdlt","pluginType":"core","aliases":[],"examples":["$ yourdlt 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 symbol-bootstrap network is generated","default":"target"}},"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":"yourdlt","pluginType":"core","aliases":[],"examples":["$ yourdlt link","$ echo \"$MY_ENV_VAR_PASSWORD\" | yourdlt 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 symbol-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}},"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.\nThe certificates are only regenerated when they are closed to expiration (30 days). If you want to renew anyway, use the --force param.\nThis command does not change the node private key (yet). This change would require a harvesters.dat migration and relinking the node key.\nIt's recommended to backup the target folder before running this operation!\n","pluginName":"yourdlt","pluginType":"core","aliases":[],"examples":["$ yourdlt 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 symbol-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}},"args":[]},"report":{"id":"report","description":"it generates reStructuredText (.rst) reports describing the configuration of each node.","pluginName":"yourdlt","pluginType":"core","aliases":[],"examples":["$ yourdlt 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 symbol-bootstrap network is generated","default":"target"}},"args":[]},"resetData":{"id":"resetData","description":"It removes the data keeping the generated configuration, certificates, keys and block 1.","pluginName":"yourdlt","pluginType":"core","aliases":[],"examples":["$ yourdlt 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 symbol-bootstrap network is generated","default":"target"}},"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":"yourdlt","pluginType":"core","aliases":[],"examples":["$ yourdlt 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 symbol-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}},"args":[]},"start":{"id":"start","description":"Single command that aggregates config, compose and run in one line!","pluginName":"yourdlt","pluginType":"core","aliases":[],"examples":["$ yourdlt start","$ yourdlt start -p bootstrap","$ yourdlt start -p testnet -a dual","$ yourdlt start -p testnet -a dual --password 1234","$ echo \"$MY_ENV_VAR_PASSWORD\" | yourdlt 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 symbol-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. The original preset (-t), assembly (-a), and custom preset (-c) must be used. Backup the target folder before upgrading.","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"},"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, can be provided via custom preset or cli parameter. If not provided, the value is resolved from the target/preset.yml file.","required":false,"helpValue":"(bootstrap|light|lightPeer|testnet|mainnet|dhealth|dhealthTestnet)","options":["bootstrap","light","lightPeer","testnet","mainnet","dhealth","dhealthTestnet"]},"assembly":{"name":"assembly","type":"option","char":"a","description":"The assembly, example \"dual\" for testnet. If not provided, the value is resolved from the target/preset.yml file.","required":false},"customPreset":{"name":"customPreset","type":"option","char":"c","description":"External preset file. Values in this file will override the provided presets","required":false},"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 (yourdlt started with --detached). This is just a wrapper for the `docker-compose down` bash call.","pluginName":"yourdlt","pluginType":"core","aliases":[],"examples":["$ yourdlt 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 symbol-bootstrap network is generated","default":"target"}},"args":[]},"updateVotingKeys":{"id":"updateVotingKeys","description":"It updates the voting files containing the voting keys when required.\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.\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.\nWhen a new voting file is created, Bootstrap will advise running the `link` command again.\n","pluginName":"yourdlt","pluginType":"core","aliases":[],"examples":["$ yourdlt 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 symbol-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."}},"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":"yourdlt","pluginType":"core","aliases":[],"examples":["$ symbol-bootstrap verify"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"It shows the help of this command.","allowNo":false}},"args":[]}}}