Crates.io | synd-term |
lib.rs | synd-term |
version | 0.3.0 |
source | src |
created_at | 2024-02-12 07:01:35.266662 |
updated_at | 2024-07-11 03:10:02.643729 |
description | terminal feed viewer |
homepage | https://docs.syndicationd.ymgyt.io/synd-term/ |
repository | https://github.com/ymgyt/syndicationd |
max_upload_size | |
id | 1136573 |
size | 5,321,759 |
Syndicationd(synd
) is a TUI feed viewer, based on feed-rs and ratatui.
Table of Contents:
nix profile install github:ymgyt/syndicationd/synd-term-v0.3.0
pacman -S syndicationd
brew install ymgyt/homebrew-syndicationd/synd-term
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/ymgyt/syndicationd/releases/download/synd-term-v0.3.0
cargo install synd-term --locked
npm install @syndicationd/synd-term
powershell -c "irm https://github.com/ymgyt/syndicationd/releases/download/synd-term-v0.3.0
docker run -it ghcr.io/ymgyt/synd-term
Pre-built binaries are available in GitHub releases.
synd
will start the TUI application.
Usage:
Commands:
clean Clean cache and logs
check Check application conditions
export Export subscribed feeds
help Print this message or the help of the given subcommand(s)
Options:
--log <LOG> Log file path [env: SYND_LOG_PATH=] [default:
/home/ymgyt/.local/share/synd/synd.log]
--cache-dir <CACHE_DIR> Cache directory [default: /home/ymgyt/.cache/synd]
--theme <THEME> Color theme [env: SYND_THEME=] [default: ferra] [possible values: ferra,
solarized-dark, helix]
-h, --help Print help
-V, --version Print version
Api options:
--endpoint <ENDPOINT> `synd_api` endpoint [env: SYND_ENDPOINT=] [default:
https://api.syndicationd.ymgyt.io:6100]
--client-timeout <CLIENT_TIMEOUT> Client timeout [default: 30s]
Feed options:
--categories <CATEGORIES TOML PATH> categories.toml path
--entries-limit <ENTRIES_LIMIT> Feed entries limit to fetch [default: 200]
GitHub options:
-G, --enable-github-notification Enable GitHub notification feature [env: SYND_ENABLE_GH=]
[aliases: enable-gh]
--github-pat <GITHUB_PAT> GitHub personal access token to fetch notifications [env:
SYND_GH_PAT]
syndicationd maintains state (such as subscribed feeds) on the backend, and therefore requires authentication to make requests.
Currently, GitHub and Google are supported as authorize server/id provider. The only scope syndicationd requires is user:email
(Github) or email
(Google) to authenticate the user's email address. The user's email address is used only as an identifier after being hashed and never stored. for more info, please refer to the privacy policy
Key | Description |
---|---|
k/j |
Move up/down |
gg |
Go to first |
ge |
Go to end |
Tab |
Switch Tab |
Enter |
Open entry/feed |
a |
Add feed subscription(on Feeds Tab) |
e |
Edit subscribed feed(on Feeds Tab) |
d |
Delete subscribed feed(on Feeds Tab) |
r |
Reload entries/feeds |
h/l |
Change requirement filiter |
c |
Activate category filiter(Esc to deactivate) |
+ |
Activate all category(on Category filter) |
- |
Deactivate all category(on Category filter) |
/ |
Activate keyword search(Esc to deactivate) |
q |
Quit app |
Key | Description |
---|---|
d |
Mark as done |
D |
Mark all as done |
u |
Unsubscribe |
f |
Open notification filter(Esc to apply) |
for more details, refer to keymap/default.rs
To subscribe a feed, type "Tab" to move to Feeds tab and then press "a".
synd
uses edit to launch the user's editor(like a git commit).
The feed to subscribe to should be entered in the format:
Requirement
Category
URL
When you close the editor, the subscription request is sent to the API.
Requirement
indicates the importance of the feed.
This uses an analogy to RFC2119 and can take one of the following values:
MUST
: Most important, must be read.SHOULD
: Next in importance, should be read unless there is a special reason not to.MAY
: Lowest importance, may be read.Category
represents the category of the feed. You can specify any value as a category. The values that synd
recognizes as categories are defined in categories.toml
. You can override the default values with the --categories
flag.
To change the requirement or category of a feed you have already subscribed to, select the target feed in the Feeds tab and then press "e".
To unsubscribe from a feed, select the target feed and press "d".
Feeds and entries can be filtered as follows.
To filter bases on the specified requirement, press "h/l(Left/Right)".
If you set the filter to MUST
, only those marked as MUST will be displayed. Setting it to SHOULD will display feeds and entries marked as MUST and SHOULD. If set to MAY, all feeds and entries will be displayed.
To filter bases on categories, presess "c". This will display a label with keys to control the activation/deactivation of each category, allowing you to toggle the visibility of categories.
Pressing "-" will deactivate all categories, and pressing "+" will activate all categories.
You can exit the filter category mode by pressing the "Esc" key.
The icons for categories can be specified in categories.toml
To export subscribed feeds, execute the synd export
command.
You can check the JSON schema of the data to be exported with synd export --print-schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Export",
"type": "object",
"required": [
"feeds"
],
"properties": {
"feeds": {
"type": "array",
"items": {
"$ref": "#/definitions/ExportedFeed"
}
}
},
"definitions": {
"ExportedFeed": {
"type": "object",
"required": [
"url"
],
"properties": {
"title": {
"type": [
"string",
"null"
]
},
"url": {
"type": "string"
}
}
}
}
}
To enable GitHub notifications feature, specify the --enable-github-notification | -G
flag or set the environment variable SYND_ENABLE_GH=true
.
When enabling the GitHub notifications feature, GitHub personal access token (PAT) is required. Specify the PAT using the --github-pat
flag or the environment variable SYND_GH_PAT
.
For GitHub notifications, unlike feeds, the synd-api is not used.
The repo
scope is required. For more details, see about github notifications.
"Metadata" repository permissions (read) and "Notifications" user permissions (read) are required.
For more details, see list notifications for the authenticated user.
Since the Mark notification as done API does not support fine grained access token, c class token is required to use this feature.
The log file path is based on ProjectDirs::data_dir()
.
Please refer to the --log
flag in synd --help
for the default output destination.
You can modify the log directives using the environment variable SYND_LOG
. (for example, SYND_LOG=synd=debug
)
The theme can be changed using the --theme
flag. Please refer to the help for the values that can be specified.
By default, synd
use https://api.syndicationd.ymgyt.io
as the backend api(hosted on my home Raspberry Pi).
To change the endpoint, specify the --endpoint
flag
The hosted api is instrumented with OpenTelemetry. Basic signals(traces,metrics,logs) are published on the
Authentication credentials are cached. to remove them, execute synd clean
.
synd check [--format (human|json)]
return current application status.
synd check --format json | from json
╭───────┬─────────────────────────────────────────╮
│ │ ╭─────────────┬────────────────────╮ │
│ api │ │ description │ health of synd-api │ │
│ │ │ status │ Pass │ │
│ │ │ version │ 0.1.9 │ │
│ │ ╰─────────────┴────────────────────╯ │
│ cache │ /home/ferris/.cache/synd │
│ log │ /home/ferris/.local/share/synd/synd.log │
╰───────┴─────────────────────────────────────────╯
This project is available under the terms of either the Apache 2.0 license or the MIT license.
Some tips about feed that I know.
Add openrss.org/
to the beginning of the URL to get its RSS feed. for example, for https://example.ymgyt.io
, it would be https://openrss.org/example.ymgyt.io
You can retrieve various updates as feeds on GitHub.
releases.atom
. for example, to obtain releases of syndicationd, specify https://github.com/ymgyt/syndicationd/releases.atom
https://github.com/ymgyt/syndicationd/tag.atom
Adding .rss
to the end of a Reddit URL allows you to retrieve the feed. for example, for https://www.reddit.com/r/HelixEditor/
, it would be https://www.reddit.com/r/HelixEditor.rss
Adding .ja.atom
to the end of a connpass group URL to get the event feed. for example, https://opentelemetry.connpass.com/ja.atom
Adding /feed
for Hatena blog
If you're looking for feeds, here are my recommendations.
Feed | URL |
---|---|
This Week in Rust | https://this-week-in-rust.org/atom.xml |
Rust Blog | https://blog.rust-lang.org/feed.xml |
Inside Rust Blog | https://blog.rust-lang.org/inside-rust/feed.xml |
RustSec Advisories | https://rustsec.org/feed.xml |
seanmonstar | https://seanmonstar.com/rss |
Mara's Blog | https://blog.m-ou.se/index.xml |
Without boats, dreams dry up | https://without.boats/index.xml |
fasterthanli.me | https://fasterthanli.me/index.xml |
Orhun's Blog | https://blog.orhun.dev/rss.xml |
axo blog | https://blog.axo.dev/rss.xml |
Kbzol's blog | https://kobzol.github.io/feed.xml |
baby steps | https://smallcultfollowing.com/babysteps/ |
COCl2's blog home | https://blog.cocl2.com/index.xml |
Feed | URL |
---|---|
This Cute World | https://thiscute.world/en/index.xml |
Determinate Systems | https://determinate.systems/rss.xml |
Feed | URL |
---|---|
observability news | https://buttondown.email/o11y.news/rss |
Opentelemetry blog | https://opentelemetry.io/blog/2024/index.xml |
eBPF Blog | https://ebpf.io/blog/rss.xml |
Feed | URL |
---|---|
Kubernetes Blog | https://kubernetes.io/feed.xml |
Kubernetes Official CVE | https://kubernetes.io/docs/reference/issues-security/official-cve-feed/feed.xml |
CNCF | https://www.cncf.io/feed/ |
Feed | URL |
---|---|
Terminal Trove | https://terminaltrove.com/blog.xml |