name: knox
about: Personal structured secret manager encrypted with GPG

subcommands:
  - init:
      about: Initializes an empty vault
      args:
        - no_git:
            long: no-git
            help: Skip the creation of a local git repository
        - identity:
            value_name: GPG_IDENTITY
            help: Email address of your GPG identity
            required: true
            multiple: true
  
  - list:
      about: List all entries in the vault
      args:
        - path:
            value_name: PATH
            help: Only list entries in this prefix

  - search:
      about: Search for a specific entry
      args:
        - term:
            value_name: TERM
            help: Term to search for

  - info:
      about: Display general information on your vault

  - identities:
      subcommands:
        - add:
            about: Add an identity to the vault (needs all identities' public keys)
            args:
              - identity:
                  value_name: GPG_IDENTITY
                  help: Email address of your GPG identity
                  required: true
              - force:
                  short: f
                  long: force
                  help: Force re-encryption of all entries, making sure this identity is included
        - delete:
            about: Remove an identity from the vault (needs all remaining public keys)
            args:
              - identity:
                  value_name: GPG_IDENTITY
                  help: Email address of the GPG identity to delete
                  required: true
              - force:
                  short: f
                  long: force
                  help: Force re-encryption of all entries, making sure this identity is removed
  
  - show:
      about: Display an entry's content
      args:
        - print:
            short: p
            long: print
            help: Print out confidential attributes
        - copy:
            short: c
            long: copy
            help: Copy the main attribute to the clipboard
        - attribute:
            short: a
            long: attribute
            help: Specify the attribute to copy or write. For copy, default, any 'password' attribute will be selected
            multiple: true
            takes_value: true
            number_of_values: 1
        - write:
            short: w
            long: write
            help: Write the file content to disk
        - stdout:
            short: s
            long: stdout
            help: Write a single file attribute to STDOUT
            requires: write
        - path:
            value_name: PATH
            help: Path to the entry
            required: true

  - add:
      about: Add an entry to the vault
      args:
        - random_length:
            short: l
            long: length
            value_name: LENGTH
            help: Length for generated random secrets
            takes_value: true
        - random_symbols:
            long: symbols
            help: Add symbols into generated random secrets
        - path:
            value_name: PATH
            help: Path to the entry
            required: true
        - attributes:
            value_name: KEY=VALUE
            help: List of attributes to set in the entry
            required: true
            multiple: true
            min_values: 1
        - force:
            long: force
            short: f
            help: Force creation of the entry, bypassing safeguards
  
  - edit:
      about: Edit an entry from the vault
      args:
        - random_length:
            short: l
            long: length
            value_name: LENGTH
            help: Length for generated random secrets
            takes_value: true
        - random_symbols:
            long: symbols
            help: Add symbols into generated random secrets
        - path:
            value_name: PATH
            help: Path to the entry
            required: true
        - attributes:
            value_name: KEY=VALUE
            help: List of attributes to set in the entry
            multiple: true
        - delete:
            short: d
            long: delete
            value_name: ATTRIBUTE
            help: Attribute to delete from the entry
            multiple: true
            number_of_values: 1
        - force:
            long: force
            short: f
            help: Force creation of the entry, bypassing safeguards

  - totp:
      subcommands:
        - configure:
            about: Set TOTP settings for this entry
            args:
              - path:
                  value_name: PATH
                  help: Path to the entry
                  required: true
              - secret:
                  short: s
                  long: secret
                  value_name: SECRET
                  help: Base32-encoded secret used for this TOTP
                  takes_value: true
              - interval:
                  short: i
                  long: interval
                  value_name: INTERVAL
                  help: Interval at which TOTP are generated, in seconds
                  takes_value: true
              - hash:
                  short: h
                  long: hash
                  value_name: HASH
                  help: 'Which hash function to use for TOTP generation (default: sha1)'
                  takes_value: true
                  possible_values: [sha1, sha256, sha512]
              - length:
                  short: l
                  long: length
                  value_name: LENGTH
                  help: 'Number of digits the TOTP must contain (default: 6)'
                  takes_value: true
        - inspect:
            about: Display the configured TOTP settings
            args:
              - path:
                  value_name: PATH
                  help: Path to the entry
                  required: true
        - show:
            about: Set TOTP settings for this entry
            args:
              - path:
                  value_name: PATH
                  help: Path to the entry
                  required: true


  - rename:
      about: Rename an entry
      args:
        - source:
            value_name: SOURCE
            help: Current path to the entry
            required: true
        - destination:
            value_name: DESTINATION
            help: New path to the entry
            required: true
  
  - delete:
      about: Delete an entry from the vault
      args:
        - path:
            value_name: PATH
            help: Path to the entry
            required: true

  - pwned:
      about: Check if the confidential attributes in an entry have been pwned
      args:
        - path:
            value_name: PATH
            help: Path to the entry. If missing, checks the whole vault
  - git:
      subcommands:
        - remote:
            about: Set the URL of the git remote repository
            args:
                - url:
                    value_name: REMOTE_URL
                    help: URL of the git remote repository
                    required: true
        - push:
            about: Push the local git repostory