aboutsummaryrefslogtreecommitdiff
path: root/README.txt
blob: 32ba8b41c4e83dc220a2d416a0ed50d86f9ab290 (plain)
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
Gnu-social Command Line Interface (gsocial-cli)
-----------------------------------------------


About
-----
gsocial-cli is an actually simple, minimalistic and full featured command-line
client for gnu-social that iteracts with 'ostatus' api using curl and core
'*nix' utilities.


Install systemwide
------------------
Manually
--------
Clone repository and copy the script into proper location (e.g /usr/bin) 

  ~$ cd /tmp

  /tmp$ git clone https://git.p4g.club/git/gsocial-cli.git gsocial-cli

  /tmp$ sudo cp gsocial-cli/gsocial-cli.sh /usr/bin/gsocial-cli

  /tmp$ sudo chmod +x /usr/bin/gsocial-cli && cd


Using installer.sh
----------------
Alternatively you can clone and run installer.sh script inside scripts 
directory (it requires sudo privileges, password will be prompted):

  ~$ cd /tmp

  /tmp$ git clone https://git.p4g.club/git/gsocial-cli.git gsocial-cli

  /tmp$ cd gsocial-cli/scripts && ./installer.sh --prefix /usr/bin/


Run ./installer.sh -h to learn about installer script


Usage
-----
Run:

  ~$ gsocial-cli -c account

    ... to configure a new account


Run:

  ~$ gsocial-cli -a <account> [option] <args>

    ... to execute script


Where Options are:
   -t   <N>               Retrieve last 'N' statuses from 'home timeline'
   -T   <N>               Retrieve last 'N' statuses from 'public timeline'
   -m   <N>               Retrieve last 'N' 'mentions' and 'interactions'
   -s   SENT              Retrieve your own 20 most recent statuses
   -e   <TAG>             Retrieve a tag's timeline
   -U   <USERRNAME> <N>   Retrieve last 'N' statuses from 'USERNAME''timeline'
   -r   <ID>              Repeat status with 'id' code number
   -d   <ID>              Delete status with 'id' code number
   -f   <ID>              Favorite status with 'id' code number
   -q   <ID>              Quote status with 'id' code number
   -R   <ID>              Reply status with 'id' code number
   -p   POST              Post a status message. Option don't uses arguments
   -h   HELP              Print this help and exit


Multiple accounts can be configured. If avoiding '-a account' is preferable, 
set default account by running:

  ~$ gsocial-cli set d_account=account


Now, running the script without '-a account' is valid:

  ~$ gsocial-cli [option] <args>