https://github.com/lovromazgon/badger-cli
A simple CLI for badger DB
https://github.com/lovromazgon/badger-cli
badger badgerdb cli go
Last synced: 13 days ago
JSON representation
A simple CLI for badger DB
- Host: GitHub
- URL: https://github.com/lovromazgon/badger-cli
- Owner: lovromazgon
- License: mit
- Created: 2024-07-28T12:41:44.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-10-31T16:53:10.000Z (7 months ago)
- Last Synced: 2025-05-04T00:51:20.420Z (16 days ago)
- Topics: badger, badgerdb, cli, go
- Language: Go
- Homepage:
- Size: 17.6 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# badger-cli
[](https://github.com/ConduitIO/conduit/blob/main/LICENSE)
[](https://goreportcard.com/report/github.com/lovromazgon/badger-cli)
`badger-cli` is a simple command-line interface for interacting with [Badger DB](https://github.com/dgraph-io/badger),
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:
```sh
brew install lovromazgon/tap/badger-cli
```
Or build it from source using Go:
```sh
go install github.com/lovromazgon/badger-cli
```
Or download the binary manually from the [latest release](https://github.com/lovromazgon/badger-cli/releases/latest).
## Usage
Run the CLI by providing the path to your Badger database:
```sh
badger-cli /path/to/your/badger/db
```
Once the CLI is running, you can use the following commands:
- `get `: Retrieve the value for a given key
- `set `: Set a value for a given key
- `delete `: Delete a key-value pair
- `list [pattern]`: List all keys, optionally filtered by a glob pattern
- `exit`: Exit the CLI
### Examples
```sh
> 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.