Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/treethought/tofui
terminally on farcaster user interface
https://github.com/treethought/tofui
farcaster farcaster-client tui
Last synced: 9 days ago
JSON representation
terminally on farcaster user interface
- Host: GitHub
- URL: https://github.com/treethought/tofui
- Owner: treethought
- License: mit
- Created: 2023-09-20T06:25:46.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-16T16:18:01.000Z (6 months ago)
- Last Synced: 2024-11-15T15:03:20.872Z (27 days ago)
- Topics: farcaster, farcaster-client, tui
- Language: Go
- Homepage: https://tofui.xyz
- Size: 2.22 MB
- Stars: 26
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-farcaster - GitHub
README
# tofui
tofui (Terminally On Farcaster User Interface) is a TUI for
[farcaster](https://www.farcaster.xyz/).
It supports running locally using your own [Neynar](https://neynar.com/)
application, or as a hosted SSH app using
[wish](https://github.com/charmbracelet/wish).
## Running Locally
Running locally requires your own Neynar application. After creating one, run the following to create your config file
```
tofui init
```
Starting tofui the first time will then give you the option to sign in
### Install
Install using go
```
go install github.com/treethought/tofui@latest
```
Or clone the repo and run
```
make build
```
Or download a binary from the
[releases](https://github.com/treethought/tofui/releases) page
Then start the TUI via `tofui`
## Keybindings
#### Navigation
| Key | Action |
| --------- | ------------------------------------------- |
| Tab | Toggle focus between sidebar and main panel |
| Shift-Tab | Toggle sidebar visibility |
| K / Up | Move up in list |
| J / Down | Move down in list |
| Escape | Go to previous view |
| Enter | Select current item |
| F
| Jump to your feed |
| Ctrl-K | Open channel quick switcher
|
| ? | Open help |
| c | View channel of current item |
| p | View profile of current item |
#### Actions
| Key | Action |
| ------ | ---------------------------------------------- |
| ctrl-d | Submit cast/reply in publish view |
| P | Open publish form |
| C | Open reply form when viewing cast |
| o | Open current cast in browser (local mode only) |
| l | Like current cast |
## Hosted version (WIP and often unavailable)
Use a hosted instance of tofui over ssh. (Note: this is WIP and currently unavailable)
```
ssh -p 42069 tofui.xyz
```
### SSH Sessions, Authentication and Details
Each SSH session is authenticated via it's SSH public key. The session then
receives it's own [Bubble Tea](https://github.com/charmbracelet/bubbletea) which
provides the interface.
For authorization, the app directs you to create a signer via Neynar's
[SIWN](https://docs.neynar.com/docs/how-to-let-users-connect-farcaster-accounts-with-write-access-for-free-using-sign-in-with-neynar-siwn).
This signer is created and managed by Neynar, and is used to provide tofui
access to your farcaster account via it's API.
This is done when both running locally and over SSH, and the signer is specific
to whichever app credentials were used. This would be tofui over SSH, or your
own app when running locally.