Skip to content

"chezmoi secret" documentation/help is misleading #4984

@bago

Description

@bago

The "chezmoi secret" command is documented here:
https://www.chezmoi.io/reference/commands/secret/

Run a secret manager's CLI, passing any extra arguments to the secret manager's CLI. This is primarily for verifying chezmoi's integration with a custom secret manager. Normally you would use chezmoi's existing template functions to retrieve secrets.

I believe this is not true as "chezmoi secret" only support "keyring" subcommand and it is used to interact with OS keyrings (e.g: under windows it can be used to interact with the Windows Credential Manager). keyring is correctly documented also here: https://www.chezmoi.io/user-guide/password-managers/keychain-and-windows-credentials-manager/

Otherwise, if the documentation is correct, then I suggest to add an example about how to use it to invoke a secret manager, like bitwarden, as I didn't find a way to do that.

The same happens in the CLI:

chezmoi secret
Description
Run a secret manager's CLI, passing any extra arguments to the secret
manager's CLI. This is primarily for verifying chezmoi's integration with a
custom secret manager. Normally you would use chezmoi's existing template
functions to retrieve secrets.

Usage:
chezmoi secret [command]

Examples:
chezmoi secret keyring set --service=service --user=user --value=password
chezmoi secret keyring get --service=service --user=user
chezmoi secret keyring delete --service=service --user=user

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions