KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#developer-tools #typescript #codex #ai-agents #claude-code #dsh #dsh-plugin #cli #macos #ai-agent #deepseek-harness #open-source

bytengine

★ 135 Open GitHub ↗

content management server

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Bytengine

[![BQL](https://github.com/johnwilson/bytengine/raw/master/bql.png)](https://raw.githubusercontent.com/johnwilson/bytengine/master/)

## About

**[Bytengine](https://github.com/johnwilson/bytengine "Bytengine")** is a scalable content 
repository built with Go. Its API is accessible from any Http client library so 
you can start coding in your favorite language!

**[Bytengine](https://github.com/johnwilson/bytengine "Bytengine")** stores your JSON data and 
digital assets in a pseudo hierarchical file system which you query using it's 
inbuilt SQL like language.

Some of the server's features are:

* JSON data management
* Digital assets management
* HTTP based API
* Bytengine Query language (BQL)
* Pluggable data storage backends (currently supports Mongodb, Diskv, Redis)
* Command line interface **[bshell](https://github.com/johnwilson/bytengine/tree/master/cmd/bshell "bshell")**

## Installation

Current Build Prerequisites:

* **[Mongodb](http://docs.mongodb.org/manual/installation/ "Mongodb")**
* **[Redis](http://redis.io/download "Redis")**

You can download Bytengine binaries for:

* **[Linux amd64](https://github.com/johnwilson/bytengine/releases/download/v0.2.2/bytengine-linux64-0.2.2.zip "Linux amd64")**
* **[Mac OS X 10.6/10.7 amd64](https://github.com/johnwilson/bytengine/releases/download/v0.2.2/bytengine-osx64-0.2.2.zip "Mac OS X 10.6/10.7 amd64")**
* **[Raspberry Pi](https://github.com/johnwilson/bytengine/releases/download/v0.2.2/bytengine-raspberry_pi-0.2.2.zip "Raspberry Pi")**

**Extract downloaded file, 'cd' into directory and run**:

```
    ./bytengine createadmin -u="admin" -p="yourpassword"
    ./bytengine run
```

## Development

Bytengine is developed on OS X so you should adapt the following instructions
to your Os/Distro (Only tested on OS X, Ubuntu Linux, Raspbian)

Current Build Prerequisites:

* [Mongodb](http://docs.mongodb.org/manual/installation/ "Mongodb")
* [Redis](http://redis.io/download/ "Redis")
* [Go](http://golang.org/doc/install/ "Go")

1. Get Bytengine `go get -d github.com/johnwilson/bytengine/cmd/bytengine`

2. `cd $GOPATH/src/github.com/johnwilson/bytengine/cmd/bytengine`

3. Build Bytengine `go build`

4. Rename `config.json.sample` to `config.json`

5. Running Bytengine
```
	./bytengine createadmin -u="admin" -p="yourpassword"
	./bytengine run
```

## Quick Tutorial

#### Using Python + [Requests](http://docs.python-requests.org/en/latest/ "Requests")

```python

>>> import requests
    >>> url = "http://localhost:8500/bfs/token"
    >>> data = {"username":"user","password":"password"}
    >>> r = requests.post(url, data=data)
    >>> j = r.json()
    >>> print j["status"]
    ok
    >>> token = j["data"]
    >>> cmd = 'server.newdb "test"; server.listdb;'  # issue two commands
    >>> url = "http://localhost:8500/bfs/query"
    >>> data = {"token":token,"query":cmd}
    >>> r = requests.post(url, data=data)
    >>> j = r.json()
    >>> print j["status"]
    ok
    >>> print j["data"][-1]  # get last result
    [u'test']
```

#### Using Bytengine Shell **[bshell](https://github.com/johnwilson/bytengine/tree/master/cmd/bshell "bshell")**

```
    bshell run -u=user -p=password
```

Enter commands:

```
    bql> server.newdb "test"; server.listdb;
    {
      "data": [
        true,
        [
          "test"
        ]
      ],
      "status": "ok"
    }
    bql> \s lastresult().status
    ok
```

## Some handy links

[Documentation](https://bytengine.readthedocs.org/en/latest/) - Bytengine Docs

[Twitter](https://twitter.com/bytengine) - Follow Bytengine

[Hemi v6](https://github.com/johnwilson/hemiv6) - Deploy to Heroku

## Thanks

[Go project](https://golang.org/project/ "Go project")

[golang-nuts](https://groups.google.com/forum/#!forum/golang-nuts "golang-nuts")
[community](https://groups.google.com/forum/#!topic/golang-nuts/grLcPuPyAyU "community")

Third-party libraries/framework developers

bytengine

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README