Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/clabe45/kaz
Minimalistic local storage cli
https://github.com/clabe45/kaz
cli data minimalistic storage utility
Last synced: about 1 month ago
JSON representation
Minimalistic local storage cli
- Host: GitHub
- URL: https://github.com/clabe45/kaz
- Owner: clabe45
- License: gpl-3.0
- Created: 2020-07-21T00:31:57.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-26T21:36:22.000Z (about 2 years ago)
- Last Synced: 2024-11-10T13:43:06.110Z (2 months ago)
- Topics: cli, data, minimalistic, storage, utility
- Language: Python
- Homepage:
- Size: 138 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Kaz
This cli lets you easily store binary and text items and retrieve them later.
## Installation
```
pip install kaz
```
## Usage
Basic usage:
```sh
kaz set key value
kaz get key # value
```
You can also use stdin and stdout:
```sh
kaz set license < license.txt
kaz get license > license2.txt
```
which works with binary files:
```sh
kaz set "profile pic" < profile-picture.png
```
## Commands
```sh
$ kaz --help
Usage: kaz [OPTIONS] COMMAND [ARGS]...
Simple local storage cli
Options:
-h, --help Show this message and exit.
-v, --version Show the version and exit.
Commands:
get Print the value of an item.
list Show all items that match `pattern`.
remove Remove an item.
set Bind a name to a value.
```
## Autocompletion
To enable autocompletion, source the script in the [autocomplete][autocomplete] directory that corresponds to your terminal. Currently bash, fish and zsh are supported.
For bash, this would be
```sh
wget https://raw.githubusercontent.com/clabe45/kaz/master/autocomplete/kaz-autocomplete-bash.sh
. kaz-autocomplete-bash.sh
```
Add the second command to your ~/.bashrc to enable it automatically.
## Contributing
1. [Fork this repo!][fork]
2. Clone: `git clone https://github.com/YOUR-USERNAME/kaz.git`
3. [Pick an issue][pick an issue] or [open a new one][open an issue] if you have a feature idea.
4. Preferably check out a new feature branch: `git checkout -b feature/my-feature` (makes the PR process easier)
5. Implement your change.
- Try to keep your commits [atomic][atomic commits].
6. Push: `git push origin FEATURE-BRANCH`
7. Create a [new pull request][new pull request].
[autocomplete]: https://github.com/clabe45/kaz/tree/master/autocomplete
[fork]: https://github.com/clabe45/kaz/fork
[pick an issue]: https://github.com/clabe45/kaz/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22
[open an issue]: https://github.com/clabe45/kaz/issues/new
[atomic commits]: https://www.freshconsulting.com/atomic-commits/
[new pull request]: https://github.com/clabe45/kaz/compare
## License
Licensed under GNU GPL v3.