#sqlite3 #key-value-store #cli #cli-config

app config-store

config-store is a simple and lightweight key-value store designed for easy use from shell scripts

3 releases (1 stable)

1.0.0 Dec 8, 2024
0.1.1 Nov 9, 2024
0.1.0 Nov 8, 2024

#84 in Configuration

Download history 178/week @ 2024-11-04 36/week @ 2024-11-11 12/week @ 2024-11-18 68/week @ 2024-12-02 90/week @ 2024-12-09

172 downloads per month

MIT/Apache

18KB
342 lines

Config-Store

Static Badge Dynamic TOML Badge

Config-Store is a simple key-value store designed to be used from shell scripts.

Example

Say, for example, you have a keybinding that switches between two applications. For this, you will probably need to save what app you are currently in.

Now you could create an entry with the set command and then toggle between the states with toggle

Usage

config-store --help or see doc comments in ./src/commands.rs

Config-store has shell completions. Simply add eval "$(config-store completions *your_shell*)" to your shell config.

Note on /tmp

Most distros will clear /tmp on boot. You should check what the case is for your distro and write your scripts accordingly, or change /tmp to clear on boot.

On NixOS this can be done by setting boot.tmp.cleanOnBoot = true;.

Installing

Simply run cargo install.

Technical details

  • The data (aka the key-value pairs) are stored in /tmp/config-store.db, which is a sqlite3 database.

  • Internally, the commands are mostly wrappers around SQL statements.

  • While it is technically possible to have multiple different entries with the same name, because the primary key is not the name. This is impossible to do with the commands provided, since set will always update a value if it exists.

  • Because the data is stored on disk, config-store needs no server process. Not only does this make it simpler, it also means there is no overhead to using it to store your variables.

License

This project is licensed under either of

at your option.

Dependencies

~24MB
~458K SLoC