A simple in memory cache written using go
A simple and a flexible in memory cache
kache aims to develop a redis compatible in memory db with golang. Currently kache is powered up with RESP Protocol. kache also supports simple text protocol so you can issue commands to kache using netcat or telnet as you please. kache has powered with many features managing a simple codebase with golang.
kache is a compiled program, download the one for your platform and extract the package to a directory you wish.
Go to that directory, open a command prompt and run the kache executable like
./kache
if you are on linux or mac
.\kache
if you are on windows
This will start the application and port 7088 will be open by default.
Try to open telnet or netcat then
$: nc localhost 7088
ping
If you get the +PONG
kache is working as expected.
Default configuration file can be found in config/kache-default.toml
kache can produce logs as you wish, in addition to default format it supports
To run with a custom config file do
./kache --config=path/to/config/file.toml
A fast and a flexible in memory database built with go
kache [flags]
--config string configuration file
-d, --debug output debug information
-h, --help help for kache
--host string host for running application (default "127.0.0.1")
--logfile string application log file
--logging set application logs (default true)
--logtype string kache can output logs in different formats like json or logfmt. The default one is custom to kache. (default "default")
--maxClients int max connections can be handled (default 10000)
--maxTimeout int max timeout for clients(in seconds) (default 120)
-p, --port int port for running application (default 7088)
-v, --verbose verbose output
mage
mage
is the build tool we use for build kache. To install mage
go get -u github.com/magefile/mage
Make sure you have an active internet connection as for the first time it will download some depedencies.
mage vendor
will install all the dependencies of the project(will take some time)mage kache
will produce the binary of the kache in bin
directorymage kachecli
will produce the binary of the kache-cli in bin
directorymage check
will run gofmt
, goimports
, go vet
and all tests with 32 bit platform includingmage fmt
will run only gofmt
on the code, will warn you when code has format errorsmage vet
will reports suspicious constructsmage imports
will check import errorsmage test
will run a unit test with defaultsmage test386
will run a test in 32-bit modemage testrace
will run a test with race
conditions enabledmage -l
for list all commandsSpecial note : According to your environment executable will be built, for windows users it will need to add .exe
to the end of -o
flag like go build -o bin/kache.exe ./cmd/kache
kache is an opensource project. Contributions are welcome