Whalebird-desktop-client-ma.../README.md

5.6 KiB

Whalebird

Build GitHub release Mac App Store AUR version Dependabot Crowdin

Whalebird is a Fediverse client app for desktop.

demo

Feature

  • An interface like slack
  • Notify to desktop
  • Streaming
  • Many keyboard shortcuts
  • Manage multiple accounts
  • Supporting
    • Mastodon
    • Pleroma
    • Misskey

Shortcuts

MacLinux, Windows
Toot, Reply Cmd + Enter Ctrl + Enter
Change accounts Cmd + 1, 2, 3... Ctrl + 1, 2, 3...
Jump to another timeline Cmd + k Ctrl + k
Reload current timeline Cmd + r Ctrl + r
Select next post j j
Select previous post k k
Reply to the post r r
Reblog the post b b
Favourite the post f f
Open details of the post o o
Open account profile of the post p p
Open the images i i
Show/hide CW and NSFW x x
Close current page esc esc
Show shortcut keys ? ?

Install

Mac

App Store

Or you can download .dmg from release page.

So on, you can install from Homebrew:

$ brew update
$ brew install --cask whalebird

Thanks to @singingwolfboy for adding it to homebrew-cask.

Linux

There are some packages in release page, for example .deb, .rpm and .AppImage. If you do not want to use the package manager, please download .tar.bz2 file and decompress it.

If you are using snap, please install from snapcraft.io.

$ sudo snap install whalebird

If you are using flatpak, please install from flathub.org.

$ flatpak install social.whalebird.WhalebirdDesktop

Or you can install from Arch User Repository.

$ yay -S whalebird

Windows

Windows Store

We prepared winget package and .exe files, but we don't recommend these ways. Because these binary is not code signed, so you will get warnings when you launch. Only Windows Store version is signed, so please use it.

$ winget show "Whalebird" --versions

Translation

If you can speak multiple languages, could you please help with translation in Crowdin?

Or if you want add new language, please create an issue. I will add it.

Development

We'd love you to contribute to Whalebird.

Minimum requirements for development

  • Node.js greater than or equal version 15.0.0 (16.x is recommended)
  • npm or yarn

Getting started

# clone this repository
$ git clone https://github.com/h3poteto/whalebird-desktop.git
$ cd whalebird-desktop

# Install font config
$ sudo apt-get install libfontconfig-dev

# install dependencies
$ yarn install

# serve with hot reload at localhost:9080
$ yarn run dev

License

The software is available as open source under the terms of the MIT License.