https://github.com/thigcampos/yacamim
Command-line browser based on Gemini protocol
https://github.com/thigcampos/yacamim
browser cli-app cli-browser gemini-protocol python
Last synced: 12 months ago
JSON representation
Command-line browser based on Gemini protocol
- Host: GitHub
- URL: https://github.com/thigcampos/yacamim
- Owner: thigcampos
- License: gpl-3.0
- Created: 2024-03-21T20:19:27.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-30T00:14:27.000Z (over 1 year ago)
- Last Synced: 2025-01-11T07:54:22.237Z (about 1 year ago)
- Topics: browser, cli-app, cli-browser, gemini-protocol, python
- Language: Python
- Homepage:
- Size: 44.9 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Yacamim
_Yacamim_ is a [Gemini](https://geminiprotocol.net) browser. Currently, it is only available as a Command-Line Application, but in the near future, a desktop application for Linux will be launched.
### Gemini Protocol
I could try to describe the project in a few words, but luckily, the Gemini developers have already done that, so let me quote them:
> 'Gemini is a new internet technology supporting an electronic library of interconnected text documents. That's not a new idea, but it's
not old-fashioned either. It's timeless and deserves tools that treat it as a first-class concept, not a vestigial corner case. Gemini isn't
about innovation or disruption; it's about providing respite for those who feel the internet has been disrupted enough already. We're not out
to change the world or destroy other technologies. We aim to build a lightweight online space where documents are just documents, in the interests
of every reader's privacy, attention, and bandwidth.'
I kind of fell in love with the idea of a simplistic internet environment, without all those shiny apps and ads all over the place.
Gemini has become my go-to place to discover new blogs and navigate between documents.
### CLI Version (Currently available)
It's a basic implementation in Python, designed to better understand how I can connect to the internet via the Gemini protocol. It's not
supposed to be used on a daily basis, but if you like the vintage vibe that comes from using the terminal to surf the internet, go ahead!
I'll add some improvements to make this experience even better for you all.
### GUI Version (Future release)
That's the main application. I'm looking to develop the 'backend' in Lua and the 'frontend' in GTK-rs. It's a really complex project, and it
might take a few months to get a working prototype, so I won't set a target release date (sorry).
### Mobile Version (In our roadmap)
It's not discarded, but also somewhat far-fetched for now. I aim to develop the GUI version first and then take a look at that.
### More Details
Visit [Gemini Specifications](https://geminiprotocol.net/docs/specification.gmi) to get more details over the implementation of this software.
### Installing
#### Globally (using `pipx`)
To install through `pipx`, run:
```bash
pipx install git+https://github.com/brasilisclub/yacamim
```
Then, you are able to use the `yacamim` command globally.
```bash
yacamim
```
#### Locally (using `poetry`)
Yacamim uses [Poetry](https://python-poetry.org) to manage its dependecies, so we recommend to install it.
Initially, you will need to clone the project:
```bash
git clone https://github.com/thigcampos/yacamim.git
```
Then, install the project using `poetry`:
```bash
poetry install
```
And, finally, run the `yacamim` command:
```bash
poetry run yacamim
```
### Usage
After intalling and running, Yacamim will prompt a input in the terminal. Similar to:
```bash
>
```
Initally, you can enter a known gemini domain, such as:
```bash
capsule.ghed.in
```
```bash
geminiprotocol.net
```
Or, leave the program, using 'q'.
As soon as you enter a valid website, every link in it will be available in the menu,
you can access the link hitting the index related to it in the input field.