Documentation
Getting Started
This page covers the installation, initial setup and basic usage of lemmoxide.
Install From The Source
git clone https://codeberg.org/lemmoxide/lemmoxide.git
cd lemmoxide
cargo build --releaseUsage
Configuration (config.toml)
User configuration is done by editing ~/.config/lemmoxide/config.toml :
[server]
url = "some lemmy instance"
username = "some_user"
password = "some_password"
[keymap]
Exit = ["q","shift-x"]
[settings]
sort_type = "New"
listing_type = "Subscribed"
limit = 50User-defined Keyboard Shortcuts - Config Section [keymaps]
It is possible to customize the keyboard shortcuts. The general syntax is assigning an array of key or key combinations to an app action. All user defined shortcuts are merged into the default keymap overwriting the default shortcut if provided by the users configuration.
User-defined Settings - Config Section [settings]
| setting | description | values |
|---|---|---|
| sort_type | sort order of posts | New, Active, Scaled, Hot, Old, MostComments, Controversial, TopAll, NewComments (default: New) |
| listing_type | scope of posts | All, Local , Subscribed, ModeratorView (default:Subscribed) |
| limit | number of post to load | positive integer < 50 (default: 50) |
User Interface - How Does It Look?
Wide Terminal Layout (content_area.width >= 90)
🐭 lemmoxide v0.1.0 - 🌐(- not connected -)
┌──────────────────────────── Posts (List) ─────────────────────────────┐┌─────────────────────────────────── Posts (Detail) ───────────────────────┐
│ > Post title 1 [42] ││ Post title 1 │
│ !community1 ││ Community: !community1 │
│ ││ Comments: 42 │
│ Post title 2 [18] ││ │
│ !community2 ││ Markdown body rendered here... │
│ ││ Link example: https://example.org │
│ ││ Another paragraph... │
│ ││ │
│ ││ <EOP> │
└───────────────────────────────────────────────────────────────────────┘└──────────────────────────────────────────────────────────────────────────┘
Posts: <count>Narrow Terminal Layout (content_area.width < 90)
🐭 lemmoxide v0.1.0 - 🌐(- not connected -)
┌──────────────────────────── Posts (List) ────────────────────────────┐
│ > Post title 1 [42] │
│ !community1 │
│ │
│ Post title 2 [18] │
│ !community2 │
└──────────────────────────────────────────────────────────────────────┘
┌──────────────────────────── Posts (Detail) ──────────────────────────┐
│ Post title 1 │
│ Community: !community1 │
│ Comments: 42 │
│ │
│ Markdown body rendered here... │
│ Highlighted links are underlined │
│ │
│ <EOP> │
└──────────────────────────────────────────────────────────────────────┘
Posts: <count>Keybindings
| Shortcut Key(s) | Purpose |
|---|---|
q | Exit the application |
Down or j | If focus is on Post List: select next post |
Down or j | If focus is on Post Detail: scroll post content down |
Up or k | If focus is on Post List: select previous post |
Up or k | If focus is on Post Detail: scroll post content up |
Left or h | Move focus to Post List pane |
Right or l | Move focus to Post Detail pane |
Tab | Toggle focus between Post List and Post Detail |
n | In Post Detail: select next detected link |
p | In Post Detail: select previous detected link |
o | Open currently selected link in external browser (only when a link is selected) |
s | Cycle sort options |
S | Open dialog to select a sort option |
t | Cycle listing types |
T | Open dialog to select a listing type |
v | View post on lemmy instance |
V | View linked post content directly if available |