https://github.com/jibstack64/know-it-all
A command-line utility for indexing, modifying and managing a database of many items.
https://github.com/jibstack64/know-it-all
command-line-tool cpp database encryption json kial utility
Last synced: 6 months ago
JSON representation
A command-line utility for indexing, modifying and managing a database of many items.
- Host: GitHub
- URL: https://github.com/jibstack64/know-it-all
- Owner: jibstack64
- License: mit
- Created: 2022-11-27T14:14:58.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-02-20T22:31:01.000Z (about 3 years ago)
- Last Synced: 2023-03-06T02:42:52.295Z (about 3 years ago)
- Topics: command-line-tool, cpp, database, encryption, json, kial, utility
- Language: C++
- Homepage:
- Size: 258 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# know-it-all
### Also known as `KIAL`.
*A command-line utility for indexing, modifying and managing a database of many items.*
> 
## Parameters
### Illustration
`[]` means non-blocking. `{}` means the parameter blocks all parameters after it, as presented below.
> #### **NOTE**
> For instance, the `+/add` parameter overwrites the `o/outfile` parameter's value as it is after it. This goes for `d/decrypt` too - if you decrypt a file, the decrypted filepath (`./decrypted.json`) will overwrite the provided `o/outfile`.
>
> The order in which you provide these arguments is obsolete; they are parsed in the order above regardless.
### Modification and appendage
- `-o/outfile ` - Specifies the target database JSON file. If none is provided, a `./database.json` will be assumed.
- `-+/add ` - Adds an item to the database by its name/identifier.
- `-!/erase` - Removes the `@/item` from the database.
- `-k/key ` - Specifies the keys to be modified on the `@/item`.
- `-v/value ` - The values to be assigned to the `k/key`.
- `-t/type ` - Specifies the types of the contents that `v/value`s hold. Can be `string`, `int` or `integer`, `float` or `decimal`, `bool` or `boolean` or `null`.
- `-@/item ` - Specifies the item to be used with the `!/erase`, `k/key` and `r/readable` parameters. If `[ALL]` is provided, then **all** items in the database will be selected.
- `-p/pop` - Pops `key`, removing it from the `@/item`.
### Catalog and iteration
- `-s/search ` - Iterates through all items in the database; if an item's name/identifier or inner value(s) contain `term`, its name/identifier and the value(s) in which `term` was found in are written to the console in a similar style to `r/readable`.
- `-C/count` - Returns the number of elements in the database.
### Encryption and decryption
> #### **NOTE**
> The encryption algorithm is a very basic two-dimensional bitshift algorithm. It works, but make sure that your password is long, or your data may be at risk from bruteforce attacks. **Your phrase cannot be a series of characters!** Otherwise your passcode is encrypted (and decrypted) as being the single character that is repeated, reducing the entire point of the encrypt/decrypt functions!
>
> If you have a repeating sequence in your phrase, for example, `testtest`, `test` will work for decrypting as well as `testtest` due to the way the algorithm works. For this reason, I suggest avoiding repeating words in your phrase.
- `-e/encrypt ` - Encrypts the `o/outfile` provided to `./encrypted.json`.
- `-d/decrypt ` - Decrypts the `o/outfile` provided to `./decrypted.json`. If no `o/outfile` is provided, an `./encrypted.json` will be used (if found).
### Other
- `-?/help [parameter]` - Provides a help-sheet for all parameters, (almost) identical to that of this README. If `parameter` is passed, only help for that single parameter will be written to the console.
- `-r/readable` - If an `@/item` is specified, the contents of that specific item will be beautified and fed to the console; if not, all items will be displayed in a neat, readable style.
- `-V/verbose` - If passed, warning errors will be shown. Use this if you are unsure to the issue at hand.
- `-c/colourless` - Disables colours. This is useful for older terminals, particularly on Windows.
- `-F/force` - Forces the program to run despite fatal errors. Use with caution.
### Builds
Releases currently ship with **Windows 7+** and **Linux** builds. You may build it yourself, add preprocessor fields for OS-compatibility, and create a PR, if you so wish.
#### Examples:
### Features to-come
- [x] Encryption and decryption.
- [x] Clean up codebase 1/2.
- [x] Clean up codebase 2/2.
- [x] Multi-key, value and type appending (e.g. `-k mykey1,mykey2 -t int,string -v 5,hi`).
- [ ] ~~Catalog search (search the web for suitable matches to an item based on its data).~~ Scrapped - not needed.
- [ ] Write/read from URL/cloud-file (e.g. `-o https://.../db.json`)
- [ ] Write/read from SSH (scp).
- [x] Compile Windows executables.
### Libraries used
[pretty.hpp](https://github.com/jibstack64/pretty) for colours, [argh.h](https://github.com/adishavit/argh) for argument parsing and [json.hpp](https://github.com/nlohmann/json) for JSON modification.