Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ryota-ka/twterm
A full-featured TUI Twitter client
https://github.com/ryota-ka/twterm
command-line ncurses readline ruby terminal twitter twitter-client
Last synced: 3 days ago
JSON representation
A full-featured TUI Twitter client
- Host: GitHub
- URL: https://github.com/ryota-ka/twterm
- Owner: ryota-ka
- License: mit
- Created: 2015-01-05T14:06:50.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T20:34:08.000Z (about 1 year ago)
- Last Synced: 2025-01-15T16:40:20.115Z (10 days ago)
- Topics: command-line, ncurses, readline, ruby, terminal, twitter, twitter-client
- Language: Ruby
- Homepage: https://twterm.ryota-ka.me
- Size: 735 KB
- Stars: 232
- Watchers: 9
- Forks: 11
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ruby-cli-apps - twterm - Twitter client. (Awesome Ruby CLIs / Third-party APIs)
README
# twterm
A full-featured TUI Twitter client
## Installation
:snowflake: Nix (Recommended)
```sh
$ nix-channel --add https://github.com/ryota-ka/twterm/archive/master.tar.gz twterm
$ nix-channel --update
$ nix-env -iA twterm
```
:warning:
If you have `BUNDLE_PATH` configured in `~/.bundle/config`, `twterm` may fail due to `Bundler::GemNotFound`.
See [NixOS/nixpkgs#85989](https://github.com/NixOS/nixpkgs/issues/85989) for details.
:beer: Homebrew
```sh
$ brew install ryota-ka/twterm/twterm
```
:gem: RubyGems
You also have to install the following dependencies manually.
- [Ruby](https://www.ruby-lang.org/) (>= 2.5, < 3, compiled with ncurses and Readline)
- [ncurses](https://invisible-island.net/ncurses/)
- [GNU Readline](https://tiswww.case.edu/php/chet/readline/rltop.html)
- [GNU Libidn](https://www.gnu.org/software/libidn/)
```sh
$ gem install twterm
```
## Usage
To launch twterm, just type in your console:
```
$ twterm
```
### Default key assignments
Key assignments can be configured by editing `~/.twterm/keys.toml`
key | operation
--- | ---
`h` `←` | previous tab
`j` `↓` | move down
`k` `↑` | move up
`l` `→` | next tab
`^N` | new tweet
`^T` | new tab
`w` | close current tab
`F10` `^C` | quit
`F1` | key assignments cheatsheet
## License
See the LICENSE file for license rights and limitations (MIT).
## Links
- http://twterm.ryota-ka.me/
- https://rubygems.org/gems/twterm
## Development
### Requirements
- [Nix](https://nixos.org/)
### Setting up development environment
```sh
$ nix-shell
```
Ruby version can be switched with `--arg` option (defaults to 2.7).
```sh
$ nix-shell --arg ruby 2.6
```