badger-cli

command module
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 31, 2024 License: MIT Imports: 8 Imported by: 0

README

badger-cli

License Go Report Card

badger-cli is a simple command-line interface for interacting with Badger DB, a fast key-value database written in Go.

Features

  • Connect to an existing Badger DB
  • Get, set, and delete key-value pairs
  • List keys with optional glob pattern matching

Installation

Install using homebrew:

brew install lovromazgon/tap/badger-cli

Or build it from source using Go:

go install github.com/lovromazgon/badger-cli

Or download the binary manually from the latest release.

Usage

Run the CLI by providing the path to your Badger database:

badger-cli /path/to/your/badger/db

Once the CLI is running, you can use the following commands:

  • get <key>: Retrieve the value for a given key
  • set <key> <value>: Set a value for a given key
  • delete <key>: Delete a key-value pair
  • list [pattern]: List all keys, optionally filtered by a glob pattern
  • exit: Exit the CLI
Examples
> set mykey myvalue
Value set successfully
> get mykey
myvalue
> list my*
mykey
> delete mykey
Value deleted successfully
> list
No matching keys found
> exit

Glob Pattern Matching

The list command supports glob pattern matching:

  • *: Matches any sequence of characters
  • ?: Matches any single character
  • [abc]: Matches any character in the set
  • [a-z]: Matches any character in the range

Examples:

  • list app_*: Lists all keys starting with "app_"
  • list *_config: Lists all keys ending with "_config"
  • list user_??: Lists all keys starting with "user_" followed by exactly two characters

Acknowledgements

The initial version of this CLI was developed with assistance from an AI language model. The code has since been modified and expanded.

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL