slk

module

v0.0.0-...-b679ee6 Latest Latest Go to latest Published: Jan 19, 2018 License: MIT

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/blinkloader/slk

Links

Open Source Insights

README ¶

slk logo

If you like minimalism, like text interfaces and type fast - then you should try slk. Its a tiny tool for writing and reading slack messages.

Benefits

minimalistic, enjoyable slack interface
no need to swich apps
helps you to save power if you need it
for those who don't like slack to be opened all the time

Demo

slk demo

Quick start

Install slk:

$  curl -sfL https://raw.githubusercontent.com/blinkloader/slk/master/install.sh | sudo sh

or

$ go get -u github.com/blinkloader/slk/...

Setup:

$ slk setup -t=<slack-token> -c=<channel> -u=<username>

<slack-token> - you can generate it here
<channel> - channel for public and private channels, @user for direct messages.
<username> - your name (yarik in demo)

Commands:

$ slk listen       #start listening for new messages
$ slk ignore       #stop listening for new messages

$ slk read         #read 10 last messages
$ slk write 'hey!' #write message to channel

$ slk to channel   #switch to public channel or private group
$ slk to @user     #switch to direct messages
$ slk on           #name of the current channel

Proposals / Contributions

Would you like to improve the tool, or have any ideas how to make it better? Feel free to open an issue.

License

MIT license

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
cmd
slk The slk command provides inteface to slack api.	The slk command provides inteface to slack api.
slkd slkd is daemon process.	slkd is daemon process.
errors Package errors holds error handling primitives	Package errors holds error handling primitives
internal
api Package api holds interface to slack api.	Package api holds interface to slack api.
cli Package cli holds primitives common to all slk commands	Package cli holds primitives common to all slk commands
cli/ignore Package ignore is a command that kills background process (slkd)	Package ignore is a command that kills background process (slkd)
cli/listen Package listen is a command that starts background channel listening process (slkd)	Package listen is a command that starts background channel listening process (slkd)
cli/on Package on is a command that prints name of the current channel	Package on is a command that prints name of the current channel
cli/read Package read is a command that returns 10 last messages from channel	Package read is a command that returns 10 last messages from channel
cli/setup Package setup is a command that sets slk configuration it must be run before any other commands	Package setup is a command that sets slk configuration it must be run before any other commands
cli/to to command switches channel (you are currently on)	to command switches channel (you are currently on)
cli/write Package write is a command that writes message to channel	Package write is a command that writes message to channel
config Package config holds all stuff related to slk configuration ($HOME/.slk)	Package config holds all stuff related to slk configuration ($HOME/.slk)
message Package message holds logic related to []*api.Message data structure	Package message holds logic related to []*api.Message data structure
out Package out holds printing primitives.	Package out holds printing primitives.
log Package log holds error printing primitives	Package log holds error printing primitives