The highest tagged major version is
README
¶
Elephant - cuz it's phat.
elephant is a service providing data and actions via various data-providers. It is meant to be a backend to create f.e. custom launchers.
Current State
The project just started and is therefore highly wip.
Communication
Communicating with elephant is done via unix-sockets and protobuf messages.
Current Providers
desktopapplicationsfilesclipboard
Quick-Guide
- You need:
elephant - ... a provider
- something to make unix socket calls with (or use
elephant query/activatefor testing)
mkdir ~/.config/elephant
mkdir ~/.config/elephant/providers
git clone https://github.com/abenz1267/elephant && cd elephant/cmd && go install elephant.go
cd ../internals/providers/desktopapplications
go build -buildmode=plugin && cp desktopapplications.so ~/.config/elephant/providers/
Once you have this setup, you can start using elephant.
Using elephant as client
elephant has a built-in tiny client which is meant for testing purpose only.
Querying: elephant query "files;somefile;5;false" => the arguments position correlate to their respective protobuf file.
Activating: elephant activate "1;desktopapplications;/usr/share/applications/firefox-developer-edition.desktop:new-private-window;"
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
comm
Package comm provides functionallity to communitate with elephant
|
Package comm provides functionallity to communitate with elephant |
|
comm/client
Package client provides simple functions to communicate with the socket.
|
Package client provides simple functions to communicate with the socket. |
|
comm/handlers
Package handlers providers all the communication handlers
|
Package handlers providers all the communication handlers |
|
common
Package common provides common functions used by all providers.
|
Package common provides common functions used by all providers. |
|
common/history
Package history provides functions to save and load history in a streamlined way.
|
Package history provides functions to save and load history in a streamlined way. |
|
providers
Package providers provides common provider functions.
|
Package providers provides common provider functions. |
|
providers/clipboard
command
Package clipboard provides access to the clipboard history.
|
Package clipboard provides access to the clipboard history. |
|
providers/desktopapplications
command
|
|
|
providers/files
command
|
|
|
util
Package util provides general utility.
|
Package util provides general utility. |
Click to show internal directories.
Click to hide internal directories.