{"id":13482497,"url":"https://github.com/marceloboeira/bojack","last_synced_at":"2025-03-27T13:31:57.102Z","repository":{"id":60334795,"uuid":"62980788","full_name":"marceloboeira/bojack","owner":"marceloboeira","description":"🐴 The unreliable key-value store","archived":true,"fork":false,"pushed_at":"2018-01-30T23:26:46.000Z","size":423,"stargazers_count":107,"open_issues_count":2,"forks_count":13,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-10-30T16:40:50.691Z","etag":null,"topics":["bojack","cache","crystal","data-storage","data-store","database","distributed","nosql","redis","ruby","storage","store"],"latest_commit_sha":null,"homepage":"http://medium.com/@marceloboeira/why-you-should-build-your-own-nosql-database-9bbba42039f5","language":"Crystal","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/marceloboeira.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-07-10T04:04:44.000Z","updated_at":"2024-07-28T12:47:22.000Z","dependencies_parsed_at":"2022-09-28T06:50:23.245Z","dependency_job_id":null,"html_url":"https://github.com/marceloboeira/bojack","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marceloboeira%2Fbojack","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marceloboeira%2Fbojack/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marceloboeira%2Fbojack/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marceloboeira%2Fbojack/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/marceloboeira","download_url":"https://codeload.github.com/marceloboeira/bojack/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245854448,"owners_count":20683356,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bojack","cache","crystal","data-storage","data-store","database","distributed","nosql","redis","ruby","storage","store"],"created_at":"2024-07-31T17:01:02.574Z","updated_at":"2025-03-27T13:31:56.738Z","avatar_url":"https://github.com/marceloboeira.png","language":"Crystal","funding_links":[],"categories":["Caching"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/marceloboeira/bojack/master/docs/bojack.png\" width=\"250\"\u003e\n  \u003ch3 align=\"center\"\u003eBoJack\u003c/h3\u003e\n  \u003cp align=\"center\"\u003eThe unreliable key-value store\u003cp\u003e\n  \u003cp align=\"center\"\u003e\n    \u003ca href=\"https://travis-ci.org/marceloboeira/bojack\"\u003e\u003cimg src=\"https://img.shields.io/travis/marceloboeira/bojack.svg?maxAge=360\"\u003e\u003c/a\u003e\n    \u003ca href=\"http://waffle.io/marceloboeira/bojack\"\u003e\u003cimg src=\"https://img.shields.io/waffle/label/marceloboeira/bojack/ready.svg?maxAge=360\"\u003e\u003c/a\u003e\n    \u003ca href=\"http://github.com/marceloboeira/bojack/releases\"\u003e\u003cimg src=\"https://img.shields.io/github/release/marceloboeira/bojack.svg?maxAge=360\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://gitter.im/bo-jack/Lobby?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge\"\u003e\u003cimg src=\"https://badges.gitter.im/bo-jack/Lobby.svg\"\u003e\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/p\u003e\n\n## Status\n\nOriginally, from my article \"[Why you should build your own NoSQL Database](http://medium.com/@marceloboeira/why-you-should-build-your-own-nosql-database-9bbba42039f5)\". BoJack is a bit mature now, yet missing several important features:\n\n - Cluster-friendliness\n - Security Layer (#34)\n - Unix Socket support (#48)\n\nFeel free to share your thoughts and [contribute](##contributing).\n\n## Installation\n\n**Requirements**\n\n* The latest version of Crystal (0.24.x)\n* LLVM development files\n\n**Steps**\n\n1. Clone the repo: `git clone https://github.com/marceloboeira/bojack`\n2. Switch to repo-directory: `cd bojack`\n3. Build: `make install` (sudo for linux users)\n\n## Showtime\n\n1. Start the server, run: `bojack server`\n2. Connect a client, in another tab, run: `bojack client`\n\n```\n$ bojack console\n\u003e set food 🍣\n🍣\n\u003e get food\n🍣\n\u003e ping\npong\n```\n\n***By default BoJack runs at 127.0.0.1:5000.***\n\n## Usage\n\n### CLI\n\nCurrently the command-line interface supports two commands: `server` and `console`.\n\n```\nbojack \u003cserver/console\u003e \u003cflags\u003e\n```\n\n### Server\n\n|flag|description||\n|---|---|---|\n|--hostname|Hostname the server will run|127.0.0.1|\n|--port|Port the server will run|5000|\n|--log|Path for a log file|STDOUT|\n|--log-level|Level of messages logged|DEBUG = 0, INFO = 1 (default), WARN = 2, ERROR = 3, FATAL = 4|\n\n### Console\n\n|flag|description|default|\n|---|---|---|\n|--hostname|Hostname this console will connect|127.0.0.1|\n|--port|Port this console will connect|5000|\n\n### Commands\n\nList of available commands for BoJack\n\n|command|description|params|example|return|\n|---|---|---|---|---|\n|set| sets a key with the given name and value  | key, value  | `set foo bar`  | the value of the key \"bar\"  |\n|increment| increments the given key value by 1| key | `increment foo`  | the value of the key \"foo\" incremented |\n|get| gets the value of the given value  | key | `get foo` | the value stored at the key, \"bar\" |\n|delete| deletes the given key | key, * | `delete foo, delete *` | the value at the deleted key \"bar\" or every key in the database, if \"*\" is given instead of a key  |\n|append| add one or more values to the end of a list | key, value  | `append list foo,bar`  | the list resulted |\n|pop| retrieve the last item of the list | key | `pop foo` | the last value stored at the list, \"foo\" |\n|size| return the number of stored items | -- | `size` | the value of stored keys in memory |\n|ping| checks the server | --  | `ping` | pong if everything is correct |\n\n### Clients\n\nWant to use BoJack with your language? Currently, we support:\n\n- [Crystal](https://github.com/hugoabonizio/bojack.cr) - Thanks to @hugoabonizio\n- [Python](https://github.com/mauricioabreu/bojack-py) - Thanks to @mauricioabreu\n- [Ruby](https://github.com/hugoabonizio/bojack.rb) - Thanks to @hugoabonizio\n- [Elixir](https://github.com/veelenga/bojack.ex) - Thanks to @veelenga\n\n## Contributing\n\nFound a bug? Have a suggestion? Please [open an issue](https://github.com/marceloboeira/bojack/issues/new).\n\nWant to contribute? Take a look at our [open issues](https://github.com/marceloboeira/bojack/issues) and make sure you follow our [guide](CONTRIBUTING.md).\n\n\n## License\n\nCheck the License [here](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarceloboeira%2Fbojack","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarceloboeira%2Fbojack","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarceloboeira%2Fbojack/lists"}