Bombabillo is a non-web client for the terminal, supporting Gopher, Gemini and much more. https://bombadillo.colorfield.space
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
sloumdrone 74473ff309 Returns license to gpl3 2 years ago
cmdparse Users can now check settings in the client and receive better messages 2 years ago
config Some level of screen draw now works 2 years ago
cui Renames a cui function to be more appropriate and adds command line flag for version number 2 years ago
gemini Fixes relative linking for gemini 2 years ago
gopher Updates gophermap rendering to support gemini urls as h URL:... style links 2 years ago
http Adds telnet and http modules, updates visit method on client 2 years ago
telnet Adds telnet and http modules, updates visit method on client 2 years ago
.gitignore Added ability to view a link's url with the check command 2 years ago
LICENSE Returns license to gpl3 2 years ago
README.md Updates readme to include language about the newly included bombadillo-info file. 2 years ago
bombadillo-info Updates readme to include language about the newly included bombadillo-info file. 2 years ago
bombadillo.1 Adds temporary ability to not add invalid value for theme. Also adds a temporary first draft of a manpage for bombadillo. 2 years ago
bookmarks.go Cleans up some display issues 2 years ago
client.go Adds status 1 support to gemini, fixes bug in url where gophertypes were getting thrown out of nongopher addresses, and fixes up relative linking in gemini maps 2 years ago
defaults.go Adds temporary ability to not add invalid value for theme. Also adds a temporary first draft of a manpage for bombadillo. 2 years ago
footbar.go Vast improvements, still squashing bugs like crazy. 2 years ago
go.mod Gofmt all code, switch to canonical function naming, add a go.mod file for use with the latest go version 3 years ago
headbar.go Fixes order of opperations issue when drawing messages 2 years ago
main.go Returns license to gpl3 2 years ago
notes.md Added focus shifting between windows redid how draws work 3 years ago
page.go Adds a terminal mode change to disallow line wrapping by the terminal, also fixes a resize scroll issue and disallows escape characters in text files 2 years ago
pages.go Vast improvements, still squashing bugs like crazy. 2 years ago
url.go Adds status 1 support to gemini, fixes bug in url where gophertypes were getting thrown out of nongopher addresses, and fixes up relative linking in gemini maps 2 years ago

README.md

Bombadillo

Bombadillo is a modern Gopher client for the terminal, and functions as a pager/terminal UI. Bombadillo features vim-like keybindings, configurable settings, and a robust command selection. Bombadillo is under active development.

Getting Started

These instructions will get a copy of the project up and running on your local machine.

Prerequisites

If building from source, you will need to have Go version >= 1.11. Bombadillo uses the module system, so if using 1.11 you will need to have that feature enabled. If using a version > 1.11, you already have modules enabled.

Bombadillo does not use any outside dependencies beyond the Go standard library.

Installing

Assuming you have go installed, run the following:

git clone https://tildegit.org/sloum/bombadillo.git
cd bombadillo
go install

Once you have done that you should, assuming go install is set up to install to a place on your path, you should be able to run the following from anywhere on your system to use Bombadillo:

bombadillo

Troubleshooting

If you run bombadillo and get bombadillo: command not found, try running go build from within the cloned repo. Then try: ./bombadillo. If that works it means that Go does not install to your path. go build added an executable file to the repo directory. Move that file to somewhere on your path. I suggest /usr/local/bin on most systems, but that may be a matter of personal preference.

Downloading

If you would prefer to download a binary for your system, rather than build from source, please visit the Bombadillo downloads page. Don't see your OS/architecture? Bombadillo can be built for use with any POSIX compliant system that is supported as a target for the Go compiler (Linux, BSD, OS X, Plan 9). No testing has been done for Windows. The program will build, but will likely not work properly outside of the Linux subsystem. If you are a Windows user and would like to do some testing or get involved in development please reach out or open an issue.

Documentation

Bombadillo has documentation available in three places currently. The first is the Bombadillo homepage, which has lots of information about the program, links to places around Gopher, and documentation of the commands and configuration options.

Secondly, and possibly more importantly, documentation is available via Gopher from within Bombadillo. When a user launches Bombadillo for the first time, their homeurl is set to the help file. As such they will have access to all of the key bindings, commands, and configuration from the first run. A user can also type :? or :help at any time to return to the documentation. Remember that Bombadillo uses vim-like key bindings, so scroll with j and k to view the docs file.

Lastly, this repo contains a file bombadillo-info. This is a duplicate of the help file that is hosted over gopher mentioned above. Per user request it has been added to the repo so that pull requests can be created with updates to the documentation.

The longterm hope is to create an installer of some sort that will move bombadillo onto a users path (compiling if need be) and installing a man file (yet to be created) onto their system. There is also talk about being able to open local files and use bombadillo as a pager, which would enable linking in the included help file.

Contributing

Bombadillo development is largely handled by Sloum, with help from jboverf and some community input. If you would like to get involved, please reach out or submit an issue. At present the developers use the tildegit issues system to discuss new features, track bugs, and communicate with users about hopes and/or issues for/with the software.

License

This project is licensed under the GNU GPL version 3- see the LICENSE file for details.