Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fedeztk/got
Translating TUI written in go using simplytranslate's API
https://github.com/fedeztk/got
cli command-line go golang translate tui
Last synced: about 1 month ago
JSON representation
Translating TUI written in go using simplytranslate's API
- Host: GitHub
- URL: https://github.com/fedeztk/got
- Owner: fedeztk
- License: mit
- Created: 2021-12-25T12:11:39.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-06-14T20:34:41.000Z (over 1 year ago)
- Last Synced: 2024-09-06T01:12:54.138Z (3 months ago)
- Topics: cli, command-line, go, golang, translate, tui
- Language: Go
- Homepage:
- Size: 7.03 MB
- Stars: 170
- Watchers: 1
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: license
Awesome Lists containing this project
- charm-in-the-wild - got - A simple translator and text-to-speech app built on simplytranslate's APIs. (_built with Bubble Tea_) (Applications / Language and Translation)
README
# got
[](https://github.com/fedeztk/got/tree/master/.github/workflows/go.yml) [](https://github.com/fedeztk/got/tree/release/.github/workflows/deploy.yml) [](https://aur.archlinux.org/packages/go-translation-git) [](https://goreportcard.com/report/github.com/fedeztk/got)
## Table of Contents
[Demo](#orgab62fc1) -
[Usage](#orgfa2aa9c) -
[Features](#org26baa6c) -
[Testing](#org2744438)
go-translation (shortly `got`), a simple translator and text-to-speech app built on top of [simplytranslate](https://codeberg.org/SimpleWeb/SimplyTranslate-Web/src/branch/master/api.md) and [lingvatranslate](https://github.com/thedaviddelta/lingva-translate) APIs. The interface is made with the awesome [bubbletea](https://github.com/charmbracelet/bubbletea) tui library.
> :warning: simplytranslate is currently down. I still kept it as a valid backend in the hope of a future comeback, by default `got` uses now lingvatranslate
Screenshots [here](#org26baa6c)
> Disclaimer: this is my absolute first project in golang, so bugs and clunky code are expected…
> The project is still a work-in-progress, breaking changes and heavy refactoring may happen
## Demo
https://user-images.githubusercontent.com/58485208/166154625-7c5556bd-74aa-4425-a046-160ba793b792.mp4
# Usage
- Install `got`:
With the `go` tool:
```sh
go install github.com/fedeztk/got/cmd/got@latest
```
**Or** from source:
```sh
# clone the repo
git clone https://github.com/fedeztk/got.git
# install manually
make install
```
In both cases make sure that you have the go `bin` directory in your path:
```sh
export PATH="$HOME/go/bin:$PATH"
```
If you are an Arch user there is also an AUR package available:
```sh
paru -S go-translation-git
```
- Copy [the sample config](https://github.com/fedeztk/got/blob/master/config.yml) file under ~/.config/got/ as config.yml **or** let the program generate one for you at the first run
- Run it interactively:
```sh
got # use last used engine, default is google
got -e reverso # change engine to reverso
```
- Or in oneshot mode:
```sh
got -o -s en -t it "Hello World" # use default (google)
got -o -e libre -s en -t it "Hello World" # use libre-translate
```
For more information check the help (`got -h`)
# Features
- Interact with various translation engines easily via the terminal, no need to open a browser!
- Clean interface with 3 tabs, switch between them with tab/shift-tab:
- **text input**: input the sentence you want to translate, press **enter** to translate
- **language selection**: choose between 108 languages, select source language with **s**, target with **t** and **i** to invert the target with the source. Press **?** to show the full help menu
Full help:
- **translation**: pager that shows the result of translation. Copy translation with **y**, listen the translation with **p**
- **engines** (only available with simplytranslate backend): choose between google, libre-translate, reverso and iciba (deepl is not working yet)
- quit anytime with **esc** or **ctrl-c**
- automatically remembers the last languages used
# Testing
Development is done through `docker`, build the container with:
make docker-build
Check that the build went fine:
docker images | grep got
Test it with:
make docker-run
Pre-built Docker image available [here](https://github.com/fedeztk/got/pkgs/container/got)