From 59324ebe4a9c843a4aa578101fcbfbaaa89352b0 Mon Sep 17 00:00:00 2001 From: cryi Date: Thu, 23 May 2024 20:54:32 +0000 Subject: [PATCH] Automated Docs Generation --- docs/cmd/tezbake.md | 3 +-- docs/cmd/tezbake_apps.md | 2 +- docs/cmd/tezbake_bootstrap-node.md | 2 +- docs/cmd/tezbake_erase-ami-cache.md | 2 +- docs/cmd/tezbake_info.md | 2 +- docs/cmd/tezbake_list-ledgers.md | 2 +- docs/cmd/tezbake_node.md | 2 +- docs/cmd/tezbake_peak.md | 2 +- docs/cmd/tezbake_register-key.md | 2 +- docs/cmd/tezbake_remove.md | 2 +- docs/cmd/tezbake_setup-ami.md | 2 +- docs/cmd/tezbake_setup-ledger.md | 17 +++++++++++++---- docs/cmd/tezbake_setup.md | 2 +- docs/cmd/tezbake_signer.md | 2 +- docs/cmd/tezbake_start.md | 2 +- docs/cmd/tezbake_stop.md | 2 +- docs/cmd/tezbake_upgrade.md | 2 +- docs/cmd/tezbake_version.md | 2 +- docs/cmd/tezbake_vote.md | 2 +- 19 files changed, 31 insertions(+), 23 deletions(-) diff --git a/docs/cmd/tezbake.md b/docs/cmd/tezbake.md index de167e0..5e12a99 100644 --- a/docs/cmd/tezbake.md +++ b/docs/cmd/tezbake.md @@ -22,7 +22,6 @@ Copyright © 2023 tez.capital * [tezbake apps](/tezbake/reference/cmd/tezbake_apps) - Prints BB CLI apps. * [tezbake bootstrap-node](/tezbake/reference/cmd/tezbake_bootstrap-node) - Bootstraps Bake Buddy's Tezos node. * [tezbake erase-ami-cache](/tezbake/reference/cmd/tezbake_erase-ami-cache) - Erases ami cache. -* [tezbake import-key](/tezbake/reference/cmd/tezbake_import-key) - Imports key from ledger. * [tezbake info](/tezbake/reference/cmd/tezbake_info) - Prints runtime information about BB. * [tezbake list-ledgers](/tezbake/reference/cmd/tezbake_list-ledgers) - Prints list of available ledgers. * [tezbake node](/tezbake/reference/cmd/tezbake_node) - Passes args through to node app. @@ -39,4 +38,4 @@ Copyright © 2023 tez.capital * [tezbake version](/tezbake/reference/cmd/tezbake_version) - Prints BB CLI version. * [tezbake vote](/tezbake/reference/cmd/tezbake_vote) - (DEPRECATED) Cast vote for proposal/s. -###### Auto generated by spf13/cobra on 22-May-2024 +###### Auto generated by spf13/cobra on 23-May-2024 diff --git a/docs/cmd/tezbake_apps.md b/docs/cmd/tezbake_apps.md index 43a4931..d3a0718 100644 --- a/docs/cmd/tezbake_apps.md +++ b/docs/cmd/tezbake_apps.md @@ -28,4 +28,4 @@ tezbake apps [flags] * [tezbake](/tezbake/reference/cmd/tezbake) - tezbake CLI -###### Auto generated by spf13/cobra on 22-May-2024 +###### Auto generated by spf13/cobra on 23-May-2024 diff --git a/docs/cmd/tezbake_bootstrap-node.md b/docs/cmd/tezbake_bootstrap-node.md index 17605ea..1cf472b 100644 --- a/docs/cmd/tezbake_bootstrap-node.md +++ b/docs/cmd/tezbake_bootstrap-node.md @@ -29,4 +29,4 @@ tezbake bootstrap-node [--no-check] [flags] * [tezbake](/tezbake/reference/cmd/tezbake) - tezbake CLI -###### Auto generated by spf13/cobra on 22-May-2024 +###### Auto generated by spf13/cobra on 23-May-2024 diff --git a/docs/cmd/tezbake_erase-ami-cache.md b/docs/cmd/tezbake_erase-ami-cache.md index 8668a37..f4550c4 100644 --- a/docs/cmd/tezbake_erase-ami-cache.md +++ b/docs/cmd/tezbake_erase-ami-cache.md @@ -28,4 +28,4 @@ tezbake erase-ami-cache [flags] * [tezbake](/tezbake/reference/cmd/tezbake) - tezbake CLI -###### Auto generated by spf13/cobra on 22-May-2024 +###### Auto generated by spf13/cobra on 23-May-2024 diff --git a/docs/cmd/tezbake_info.md b/docs/cmd/tezbake_info.md index 7372393..8eb326b 100644 --- a/docs/cmd/tezbake_info.md +++ b/docs/cmd/tezbake_info.md @@ -40,4 +40,4 @@ tezbake info [flags] * [tezbake](/tezbake/reference/cmd/tezbake) - tezbake CLI -###### Auto generated by spf13/cobra on 22-May-2024 +###### Auto generated by spf13/cobra on 23-May-2024 diff --git a/docs/cmd/tezbake_list-ledgers.md b/docs/cmd/tezbake_list-ledgers.md index f62272f..4dc0eae 100644 --- a/docs/cmd/tezbake_list-ledgers.md +++ b/docs/cmd/tezbake_list-ledgers.md @@ -28,4 +28,4 @@ tezbake list-ledgers [flags] * [tezbake](/tezbake/reference/cmd/tezbake) - tezbake CLI -###### Auto generated by spf13/cobra on 22-May-2024 +###### Auto generated by spf13/cobra on 23-May-2024 diff --git a/docs/cmd/tezbake_node.md b/docs/cmd/tezbake_node.md index 2ce8e57..17b7d96 100644 --- a/docs/cmd/tezbake_node.md +++ b/docs/cmd/tezbake_node.md @@ -28,4 +28,4 @@ tezbake node [flags] * [tezbake](/tezbake/reference/cmd/tezbake) - tezbake CLI -###### Auto generated by spf13/cobra on 22-May-2024 +###### Auto generated by spf13/cobra on 23-May-2024 diff --git a/docs/cmd/tezbake_peak.md b/docs/cmd/tezbake_peak.md index 3f50fb2..00386b7 100644 --- a/docs/cmd/tezbake_peak.md +++ b/docs/cmd/tezbake_peak.md @@ -28,4 +28,4 @@ tezbake peak [flags] * [tezbake](/tezbake/reference/cmd/tezbake) - tezbake CLI -###### Auto generated by spf13/cobra on 22-May-2024 +###### Auto generated by spf13/cobra on 23-May-2024 diff --git a/docs/cmd/tezbake_register-key.md b/docs/cmd/tezbake_register-key.md index 5fa9b7e..79c3366 100644 --- a/docs/cmd/tezbake_register-key.md +++ b/docs/cmd/tezbake_register-key.md @@ -28,4 +28,4 @@ tezbake register-key [flags] * [tezbake](/tezbake/reference/cmd/tezbake) - tezbake CLI -###### Auto generated by spf13/cobra on 22-May-2024 +###### Auto generated by spf13/cobra on 23-May-2024 diff --git a/docs/cmd/tezbake_remove.md b/docs/cmd/tezbake_remove.md index 9c167fe..7162ba8 100644 --- a/docs/cmd/tezbake_remove.md +++ b/docs/cmd/tezbake_remove.md @@ -32,4 +32,4 @@ tezbake remove [flags] * [tezbake](/tezbake/reference/cmd/tezbake) - tezbake CLI -###### Auto generated by spf13/cobra on 22-May-2024 +###### Auto generated by spf13/cobra on 23-May-2024 diff --git a/docs/cmd/tezbake_setup-ami.md b/docs/cmd/tezbake_setup-ami.md index 2e8b352..222441e 100644 --- a/docs/cmd/tezbake_setup-ami.md +++ b/docs/cmd/tezbake_setup-ami.md @@ -29,4 +29,4 @@ tezbake setup-ami [flags] * [tezbake](/tezbake/reference/cmd/tezbake) - tezbake CLI -###### Auto generated by spf13/cobra on 22-May-2024 +###### Auto generated by spf13/cobra on 23-May-2024 diff --git a/docs/cmd/tezbake_setup-ledger.md b/docs/cmd/tezbake_setup-ledger.md index 7baf449..17daab7 100644 --- a/docs/cmd/tezbake_setup-ledger.md +++ b/docs/cmd/tezbake_setup-ledger.md @@ -13,9 +13,18 @@ tezbake setup-ledger [flags] ### Options ``` - -h, --help help for setup-ledger - --main-chain-id string Id of chain to be used for baking. - --main-hwm string High watermark to be used during baking. + --authorize Authorize ledger for baking. + --chain-id string Id of chain to be used for baking. + -f, --force Force key import. (overwrites existing) + -h, --help help for setup-ledger + --hwm string High watermark to be used during baking. + --import-key [string][=true] Import key from ledger (optionally specify derivation path) (default ) + --key-alias string Alias ofkey to be imported (default "baker") + --ledger-id string Ledger id to import key from (affects import-key only) + --no-udev string Skip udev rules installation. (linux only) + -n, --node Import key to node (affects import-key only) + --platform [string][=true] Prepare platform for ledger (optionally specify platform to override) (default ) + -s, --signer Import key to signer (affects import-key only) ``` ### Options inherited from parent commands @@ -30,4 +39,4 @@ tezbake setup-ledger [flags] * [tezbake](/tezbake/reference/cmd/tezbake) - tezbake CLI -###### Auto generated by spf13/cobra on 22-May-2024 +###### Auto generated by spf13/cobra on 23-May-2024 diff --git a/docs/cmd/tezbake_setup.md b/docs/cmd/tezbake_setup.md index 9711053..acd1dc4 100644 --- a/docs/cmd/tezbake_setup.md +++ b/docs/cmd/tezbake_setup.md @@ -51,4 +51,4 @@ tezbake setup [flags] * [tezbake](/tezbake/reference/cmd/tezbake) - tezbake CLI -###### Auto generated by spf13/cobra on 22-May-2024 +###### Auto generated by spf13/cobra on 23-May-2024 diff --git a/docs/cmd/tezbake_signer.md b/docs/cmd/tezbake_signer.md index a283493..a928647 100644 --- a/docs/cmd/tezbake_signer.md +++ b/docs/cmd/tezbake_signer.md @@ -28,4 +28,4 @@ tezbake signer [flags] * [tezbake](/tezbake/reference/cmd/tezbake) - tezbake CLI -###### Auto generated by spf13/cobra on 22-May-2024 +###### Auto generated by spf13/cobra on 23-May-2024 diff --git a/docs/cmd/tezbake_start.md b/docs/cmd/tezbake_start.md index a226ebe..d8b1130 100644 --- a/docs/cmd/tezbake_start.md +++ b/docs/cmd/tezbake_start.md @@ -31,4 +31,4 @@ tezbake start [flags] * [tezbake](/tezbake/reference/cmd/tezbake) - tezbake CLI -###### Auto generated by spf13/cobra on 22-May-2024 +###### Auto generated by spf13/cobra on 23-May-2024 diff --git a/docs/cmd/tezbake_stop.md b/docs/cmd/tezbake_stop.md index 98c0583..99762f9 100644 --- a/docs/cmd/tezbake_stop.md +++ b/docs/cmd/tezbake_stop.md @@ -31,4 +31,4 @@ tezbake stop [flags] * [tezbake](/tezbake/reference/cmd/tezbake) - tezbake CLI -###### Auto generated by spf13/cobra on 22-May-2024 +###### Auto generated by spf13/cobra on 23-May-2024 diff --git a/docs/cmd/tezbake_upgrade.md b/docs/cmd/tezbake_upgrade.md index 075494d..89cfac9 100644 --- a/docs/cmd/tezbake_upgrade.md +++ b/docs/cmd/tezbake_upgrade.md @@ -33,4 +33,4 @@ tezbake upgrade [flags] * [tezbake](/tezbake/reference/cmd/tezbake) - tezbake CLI -###### Auto generated by spf13/cobra on 22-May-2024 +###### Auto generated by spf13/cobra on 23-May-2024 diff --git a/docs/cmd/tezbake_version.md b/docs/cmd/tezbake_version.md index b777e43..ae9fc19 100644 --- a/docs/cmd/tezbake_version.md +++ b/docs/cmd/tezbake_version.md @@ -34,4 +34,4 @@ tezbake version [flags] * [tezbake](/tezbake/reference/cmd/tezbake) - tezbake CLI -###### Auto generated by spf13/cobra on 22-May-2024 +###### Auto generated by spf13/cobra on 23-May-2024 diff --git a/docs/cmd/tezbake_vote.md b/docs/cmd/tezbake_vote.md index dd9184e..c626ee6 100644 --- a/docs/cmd/tezbake_vote.md +++ b/docs/cmd/tezbake_vote.md @@ -39,4 +39,4 @@ tezbake vote [flags] * [tezbake](/tezbake/reference/cmd/tezbake) - tezbake CLI -###### Auto generated by spf13/cobra on 22-May-2024 +###### Auto generated by spf13/cobra on 23-May-2024