quickvault

1.0.12 • Public • Published

Quick Vault

quickvault logo

npm install -g quickvault

A fast and reliable key-value store CLI.
Quickvault is a zero dependency cli application for persistent storage of environment variables
It allows for storing and retrieving key value pairs using the commandline.

Commands:

  • help
    Get usage details and available commands for quickvault
    quickvault help

  • add:
    quickvault add KEY VALUE
    Add KEY and its corresponding value to vault

    Demonstrates add command - Add KEY and its corresponding value to vault

  • get:
    quickvault get KEY
    Get a value from the vault for a corresponding key

    Demonstrates get command - Get a value from the vault for a corresponding key

  • edit
    quickvault edit KEY VALUE
    Edit the value for a corresponding key

    Demonstrates edit command - Edit the value for a corresponding key

  • del
    quickvault del KEY
    Delete a key-value pair

    Demonstrates delete command - Delete a key-value pair

  • dump:
    quickvault dump
    Get all values in json format on the cli

    dump command - Get all values in json format on the cli

  • stat:
    quickvault stat
    Stats for the vault

    stat command - displays no of keys in vault,location of vault, size, last access time

  • search:
    quickvault search PATTERN
    Search for keys matching a particular pattern

    Quickvault Search command for keys matching a particular pattern

  • clear:
    Empty the vault
    quickvault clear

    Demonstrates clear command - resets the vault by removing all key-value pairs

  • env:
    Generate a .env file at the specified path.
    Use . or ./ to generate .env at current working directory
    quickvault env PATH

  • backup
    quickvault backup LOCATION
    Creates a backup(backup.json) of vault's current state at specified location

  • restore
    quickvault restore OPTION PATH
    Restore a key-value json from specified path.
    Options:"--append" OR "--replace"

  • config
    quickvault config OPTION VALUE
    Change configuration options - (encryption)
    "quickvault config" to view availbale pre-sets.


Command Recommendtation suggests nearset possible matching command in case of typos
Command Recommendtation is based on Levenshtein distance



On the horizon - Coming Soon Features

  • TTL Keys: Temporary key value pairs that "self-destruct" i.e. delete automatically after specified time. Effective for stroing temporary variables
  • Command Alias: Allow users to define custom aliases for commands.
  • Value Truncation: Limit the displayed length of long values in the output for better readability

Additional Features

  • Command History Log: Keep track of executed commands
  • Quiet Mode: Introduce a quiet mode (-q or --quiet) to suppress unnecessary output for automation or scripting purposes.

⭐ Don't forget to leave a star! ⭐

Package Sidebar

Install

npm i quickvault

Weekly Downloads

1

Version

1.0.12

License

MIT

Unpacked Size

51.3 kB

Total Files

21

Last publish

Collaborators

  • rutujrunwal