Skip to content
GGP1 edited this page Jul 28, 2024 · 12 revisions

By default, kure reads the file at $HOME/.kure/kure.yaml or the one specified in the KURE_CONFIG environment variable. To use a different file, simply change the environment variable.

Supported formats: JSON, TOML, YAML.

Helpful commands

  1. kure config -> Read current file
  2. kure config create -> Create a new file
  3. kure config edit -> Edit current file

Sample

Here is a sample configuration in YAML. For a sample on every format supported, visit docs/samples.

Paths must be absolute.

clipboard:
  timeout: "5s"
database:
  path: "/home/user/kure.db"
editor: "vim"
keyfile:
  path: "/home/user/sample.key"
session:
  prefix: "kure:~$"
  scripts: 
    login: copy $1 -u -t 4s && copy $1 -t 4s && 2fa $1 -c -t 5s
    create: add $1 -l 25 && 2fa add $1
    show: ls $1 -s && 2fa $2
  timeout: "10m"

Keys

Clipboard

Timeout

Time until the clipboard is cleared after a record has been copied to it. Set to "0s" or leave blank for no timeout.


Database

Path

Path to the database file (if it doesn't exist, it will be created). It must be absolute.


Editor

The command of the editor you would like to use. If the editor flag is empty and no editor is set in the configuration file, Kure will look for it in the $EDITOR and $VISUAL environment variables, if still nothing is found, it will try using vim by default.


Keyfile

Path

The path to the key file may be specified or not, in case it's not, the user will be asked for it everytime he wants to access the database, in the other case the user has to input the password only.


Session

Prefix

Text that precedes your commands.

Scripts

Scripts can be used to run a sequence of commands inside sessions. Each one of them has an alias and may contain one-based indexing arguments ($1, $2, ..., $n) to be replaced by the arguments passed when executing the script. For example, having the script list: ls $1 -s we execute it by typing list sample, that is <alias> <$1>.

Aliases must not contain spaces and arguments containing spaces must be enclosed by double quotes.

Timeout

Time until the session is closed. Set to "0s" or leave blank for no timeout.