aboutsummaryrefslogtreecommitdiff
path: root/README.org
blob: 7ccf82433550498ef18f0617c980844efadfdd9b (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
* =ol= the oneliners.wiki command-line interface 

** Installation

For now you need to build it from source.

First clone it 

: git clone https://cicadas.surf/cgit/oneliners/oneliners.cli.git oneliners.cli 

then =cd= into the =oneliners.cli= directory and type make app 

: cd oneliners.cli 
: make app 

If the build was successful, the executable will be in =bin/ol= 

I usually place it into =~/.local/bin/=

*!!! ONLY TESTED WITH SBCL !!!* 
     
** Configuration 

The first time you try to run the =ol= command to do anything other
than printing the help menu, you will be prompted to configure it. 

At present there are only two configuration options handled here: a
host and a shell. The host is where the =ol= command will make
requests. The shell is the shell environment where you want to run
oneliners.  Host defaults to https://api.oneliners.wiki and shell
defaults to =bash=.

If you just want to lookup and run oneliners from the default wiki,
you just need to accept the defaults offered by the configuration
prompts.

If you are self-hosting a oneliners wiki server, you'll need to enter
the address of that server when prompted for a host.  

E.g. if you are running a server locally on port 8080, you'd enter
=http://127.0.0.1:8080= 

** Contributing 
   
   To get a look at what I intend to add or change or fix you can look [[https://cicadas.surf/~colin/project-oneliners.wiki.html][here]] 
   
   If you'd like to contact me, you can email me at colin@cicadas.surf
   or message me on mastodon @antisphex@mastodon.sdf.org 

   If you have made an improvement that you would like me to include
   here, you can: 

   1. point me to a publicly accessible git repo so I can pull your branch 
   2. send me a patch file by email   

* License  

Licensed under the AGPLv3 License.