docs: align instructions with current binary status

Author: bbortt

README.md

@@ -68,8 +68,8 @@ The configuration file is in YAML format and has the following structure:
 | `argo_cd`  |                          | ArgoCD-related configuration                                                             | ✔️                         |
 |            | `application`            | The name of the application you'd like to synchronise inside ArgoCD                      | ✔️                         |
 |            | `base_url`               | The base URL of your ArgoCD instance                                                     | ✔️                         |
-|            | `danger_accept_insecure` | Whether to accept insecure/self-signed SSL certificates (not recommended for production) | ❌                         |
-|            | `sync_timeout_seconds`   | The timeout in seconds for the synchronization process                                   | ❌                         |
+|            | `danger_accept_insecure` | Whether to accept insecure/self-signed SSL certificates (not recommended for production) | ❌ (default: `false`)      |
+|            | `sync_timeout_seconds`   | The timeout in seconds for the synchronization process                                   | ❌ (default: `60`)         |
 | `postgres` |                          | PostgreSQL database configuration                                                        |                            |
 |            | `host`                   | The hostname or IP address of the PostgreSQL server                                      | ✔️ (if `postgres` is used) |
 |            | `port`                   | The port number on which PostgreSQL is running                                           | ✔️ (if `postgres` is used) |
@@ -92,7 +92,6 @@ Here's an example configuration file with explanations:
 argo_cd:
   application: 'propeller'
   base_url: 'http://localhost:8080'
-  danger_accept_insecure: false # Only use 'true' in non-production environments
   sync_timeout_seconds: 60
 
 # PostgreSQL configuration (required if using a PostgreSQL database)
@@ -163,6 +162,28 @@ propeller init-vault [OPTIONS]
 
 #### Options
 
+```shell
+Initialize a Vault path with the necessary structure for secret management.
+
+This command prepares the Vault backend for subsequent secret rotation operations.
+
+Usage: propeller.exe init-vault [OPTIONS]
+
+Options:
+  -c, --config-path <CONFIG_PATH>
+          Path to the configuration file (default: config.yml)
+
+          [default: config.yml]
+
+  -h, --help
+          Print help (see a summary with '-h')
+
+  -V, --version
+          Print version
+```
+
+Additionally, have a look at the ["Configuration"](#configuration) chapter.
+
 #### Result
 
 After running the command, the specified Vault path will contain a JSON secret with the following structure:
@@ -198,6 +219,39 @@ propeller rotate [OPTIONS]
 
 #### Options
 
+```shell
+Rotate PostgreSQL database secrets.
+
+This command orchestrates the process of generating new secrets, updating the database, and storing the new secrets in Vault.
+
+Usage: propeller.exe rotate [OPTIONS]
+
+Options:
+  -c, --config-path <CONFIG_PATH>
+          Path to the configuration file (default: config.yml)
+
+          [default: config.yml]
+
+  -p, --password-length <PASSWORD_LENGTH>
+          The length of the randomly generated alphanumeric password
+
+          [default: 20]
+
+  -h, --help
+          Print help (see a summary with '-h')
+
+  -V, --version
+          Print version
+```
+
+Additionally, have a look at the ["Configuration"](#configuration) chapter.
+
+#### Result
+
+If all goes well, the active user will have been switched.
+The passwords of both the user 1 and 2 will have been rotated.
+The binary makes sure that your running application is in sync at all times!
+
 #### Sequence Diagram "Switch"
 
 !["switch" Workflow](https://www.plantuml.com/plantuml/png/nLGzJyCm4DtzAqxg0aDL6jHMT42gYc1XA1JOZNEabbpRs4uh_ZtEjvEc1Q5AP72aoxrxTy_legbnd75DfOELKHg5G0E3-sXnTJKZElZwHbFXMf6LiYunk7vwXC5YEfb4qzRdXKdKyguTqbfmHXrNaX2f78BQUReW38FnT7OzlI7Wdp2UMhJPOM1CKCQGeGcXpF4TzNNgtWbfnXZU5btFuHa_KxGEydpCwpJOOhByXA77r0Nc5M6CdUGsIG1uG8acopDKnceBcbgxLoRk8chfV6_APO2SAce0pMXrBWaKxpIwJXb3QyDE0rol9gywFibxGfOUjZvTIgBrdZks2RK7fqhUSz8LXfl3Y-59uaD62Q5Irr2KZYnUEQ8nc6VvaYp83QnQ0NxigYGWeN7_QC9MQwLMX_DtY49RBPMKo1nuyJS7OX_tL8kth95LzutJTy7j1kCZ9WjrECUUHy6U2wMqvn82KkcugAuMcDfgWLbzxoc-nUowUprHQLy1_JGkjKUjqRdfF1akj6-8osHaYviVVL0kCBxiSO1F_EN6Z_zfuyVdslYGl_u9VmC0)

src/cli.rs

@@ -42,10 +42,6 @@ pub(crate) struct RotateArgs {
     /// The length of the randomly generated alphanumeric password
     #[clap(short, long, default_value = "20")]
     pub(crate) password_length: usize,
-
-    /// Whether the CLI should write a recovery log (contains sensitive information!) or not
-    #[clap(short, long)]
-    pub(crate) write_recovery_log: bool,
 }
 
 /// Arguments specific to the `init-vault` subcommand.