blob: c997fcbc3fc85a6aff44e154221fd2fc5f70f297 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
|
━━━━━━━━━
PYXIS
Andinus
━━━━━━━━━
Table of Contents
─────────────────
1 Documentation
.. 1.1 Commands
.. 1.2 Examples
.. 1.3 Configuration
Pyxis is a simple twtxt client.
[twtxt] is a decentralised, minimalist microblogging service for
hackers.
• Website: [https://andinus.nand.sh/pyxis]
• Source: [https://git.tilde.institute/andinus/pyxis]
• Mirror: [https://github.com/andinus/pyxis]
[twtxt] https://github.com/buckket/twtxt
1 Documentation
═══════════════
The feeds are saved in `$XDG_DATA_HOME/pyxis', if it's not defined
then `$HOME/.local/share/pyxis' is used. Feeds are configured in
`$XDG_CONFIG_HOME/pyxis.pl' or `$HOME/.config/pyxis.pl'.
1.1 Commands
────────────
1.1.1 fetch
╌╌╌╌╌╌╌╌╌╌╌
fetch will fetch all the latest feeds from config file. You can use
Pyxis without this feature by fetching the files yourself manually to
data directory.
1.1.2 timeline
╌╌╌╌╌╌╌╌╌╌╌╌╌╌
timeline will print your timeline from all the feeds. You can also
pass an optional argument to load custom feeds.
For example, you can pass multiple feeds like `pyxis timeline f1 f2',
it'll load both `f1' & `f2'. If you pass an invalid feed then it
prints a warning & goes to the next one.
1.2 Examples
────────────
┌────
│ pyxis fetch # fetch all feeds
│
│ # dispay emacs & perl feeds (if available)
│ pyxis timeline emacs perl
│
│ pyxis timeline # display all feeds
└────
1.3 Configuration
─────────────────
There is an example config file under `share/config.pl', move it
config directory & rename it to `pyxis.pl'.
*Warning*: Pyxis will evaluate the configuration file, which means an
attacker can use it to run malicious code.
*Note*: They could always add malicious code to `.profile' & do harm.
Just thought I should put the warning.
┌────
│ #!/usr/bin/perl
│
│ use strict;
│ use warnings;
│
│ my %feeds = (
│ example => "https://example.com/twtxt.txt",
│ );
│
│ sub get_feeds { return %feeds; }
│
│ 1;
└────
Add your feeds to `%feeds' hash like shown above. You can remove those
2 `use' lines but it's good if you keep them.
|