Categorygithub.com/br0xen/boltbrowser
modulepackage
0.0.0-20230531143731-fcc13603daaf
Repository: https://github.com/br0xen/boltbrowser.git
Documentation: pkg.go.dev

# README

boltbrowser

A CLI Browser for BoltDB Files

Image of About Screen

Image of Main Browser

Installing

Install in the standard way:

go get github.com/br0xen/boltbrowser

Then you'll have boltbrowser in your path.

Pre-built Binaries

Pre-build binaries are available on the Releases Page.

Usage

Just provide a BoltDB filename to be opened as the first argument on the command line:

boltbrowser <filename>

To see all options that are available, run:

boltbrowser --help

Troubleshooting

If you're having trouble with garbled characters being displayed on your screen, you may try a different value for TERM.
People tend to have the best luck with xterm-256color or something like that. Play around with it and see if it fixes your problems.

# Constants

AboutScreenIndex The idx number for the 'About' Screen.
BrowserScreenIndex is the index.
No description provided by the author
ExitScreenIndex The idx number for Exiting.

# Variables

No description provided by the author
No description provided by the author
No description provided by the author

# Structs

BoltBucket is just a struct representation of a Bucket in the Bolt DB */.
BoltDB A Database, basically a collection of buckets */.
BoltPair is just a struct representation of a Pair in the Bolt DB */.
BrowserScreen holds all that's going on :D */.
Command is a struct for associating descriptions to keys */.
No description provided by the author
No description provided by the author
Style Defines the colors for the terminal display, basically */.
ViewPort helps keep track of what's being displayed on the screen */.

# Interfaces

Screen is a basic structure for all of the applications screens.

# Type aliases

AboutScreen is just a basic 'int' type that we can extend to make this screen */.
BoltType is just for tracking what type of db item we're looking at */.
BrowserMode is just for designating the mode that we're in */.