https://github.com/makenowjust/bashcached

memcached server built on bash + socat
https://github.com/makenowjust/bashcached

bash bash-hacks bash-script memcached shell-script socat

Last synced: about 1 month ago
JSON representation

memcached server built on bash + socat

• Host: GitHub
• URL: https://github.com/makenowjust/bashcached
• Owner: makenowjust
• License: mit
• Created: 2016-10-28T10:29:20.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2020-01-10T01:30:22.000Z (almost 5 years ago)
• Last Synced: 2024-04-14T23:14:59.884Z (7 months ago)
• Topics: bash, bash-hacks, bash-script, memcached, shell-script, socat
• Language: Ruby
• Homepage: https://git.io/bashcached
• Size: 60.5 KB
• Stars: 271
• Watchers: 13
• Forks: 11
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# bashcached

> memcached server built on [bash] + [socat]

[bash]: https://www.gnu.org/software/bash/

[socat]: http://www.dest-unreach.org/socat/

[![CircleCI](https://circleci.com/gh/MakeNowJust/bashcached.svg?style=svg)](https://circleci.com/gh/MakeNowJust/bashcached)

## Feature

It is one file script (small, `(($(< bashcached wc -l) < 100))`!), and it requires only:

  - `bash`

  - `socat`

So, you can use it as soon as you download it.

It supports multiple connections and implements almost all memcached commands:

  - `set`, `add`, `replace`, `append` and `prepend`

  - `get`, `delete` and `touch`

  - `incr` and `decr`

  - `gets` and `cas`

  - `flush_all`

  - `version` and `quit`

And, it supports to serve over `tcp` and `unix` domain socket.

## Install

You could install `base64`, `bash` and `socat` via `brew` if you use macOS:

```console

$ brew install base64 bash socat

```

(In fact, `bash` is installed in the default on macOS, however it is *too old* to run `bashcached`.)

Or, you could install `socat` via `apt` if you use Ubuntu:

```console

$ sudo apt install socat

```

then, download and chmod.

```console

$ curl -LO https://git.io/bashcached

$ chmod +x bashcached

```

Or, you could use [`bpkg`](https://github.com/bpkg/bpkg) instaed of downloading script:

```console

$ bpkg install MakeNowJust/bashcached -g

```

## Usage

```console

$ ./bashcached --help

bashcached - memcached built on bash + socat

(C) TSUYUSATO "MakeNowJust" Kitsune 2016-2020 

USAGE: bashcached [--help] [--version] [--license] [--protocol=tcp|unix] [--port=PORT] [--check=CHECK]

OPTIONS:

  --protocol=tcp|unix      protocol name to bind and listen (default: tcp)

  --port=PORT              port (or filename) to bind and listen (default: 25252)

  --check=CHECK            interval to check each cache's expire (default: 60)

  --help                   show this help

  --version                show bashcached's version

  --license                show bashcached's license

$ ./bashcached &

$ telnet localhost 25252

version

VERSION 5.2.0-bashcached

set hello 0 0 11

hello world

STORED

get hello

VALUE hello 0 11

hello world

END

quit

```

## License and Copyright

MIT and [:sushi:](https://github.com/MakeNowJust/sushi-ware)

© TSUYUSATO "[MakeNowJust](https://quine.codes)" Kitsune <> 2016-2018