Eve is a set of tools to help us think. Currently, these tools include: a temporal query language, a compiler, and a database.
Eve is currently at a very early, "pre-alpha" stage of development. This means the language, tools, and docs are largely incomplete, but undergoing rapid and continuous development. If you encounter errors while using Eve, don't worry: it's likely our fault. Please bring the problem to our attention by filing an issue.
As always, with pre-release software, don’t use this for anything important. We are continuously pushing to this codebase, so you can expect very rapid changes. At this time, we’re not prepared make the commitment that our changes will not break your code, but we’ll do our best to update you on the biggest changes.
To build Eve from source, you'll need LuaJIT, gcc, make, and python. Currently, building from source is only supported on Linux and OSX. On Windows, we've managed to compile Eve in cygwin, but have not gotten it to run yet. Contributions are welcome on this front.
Install luajit by downloading LuaJIT-2.1.0-beta2 and then in the LuaJIT directory:
make
make install
By default, LuaJIT is not added to your path, so you'll need to do that as well:
ln -sf luajit-2.1.0-beta2 /usr/local/bin/luajit
then execute make in the eve/build directory.
Eve is also on Docker Hub. You can get our container with the following command:
docker pull witheve/eve
Windows Users - Docker for Windows requires Microsoft Hyper-V, which requires Windows 10. For users of earlier Windows versions, binaries are forthcoming.
To run Eve, in the eve/build execute:
./eve -e [eve_file]
where [eve_file] is the location of an *.eve file you want to compile. This process launches a server at http://localhost:8080. You can point your browser there to see the results of the compilation. You can configure the port with the --port flag. e.g. ./eve --port 1234.
To run the Docker container, execute:
docker run -p [port]:8080 witheve/eve [eve_file]
Here, [port] is an available port on your local machine. It can be 8080 or any other port you would like. Then direct your browser to http://localhost:[port] to access the results. Note: To pass your own Eve files into the container, you'll need to mount a docker volume.
The easiest way to use Eve is to write an Eve file in your favorite text editor, then compile it using the steps above.
For now the Syntax RFC acts as an interim tutorial while we work on something more complete.
Finally, you can communicate with Eve using websockets and a very simple JSON protocol. For now, the web interface is the only tool that implements this protocol.
Please let us know what kind of documents would be the most helpful as you begin your journey with Eve. We want our documentation to be a highlight of the Eve experience, so any suggestions are greatly appreciated.
Coming Soon...
The Eve community is small but constantly growing, and everyone is welcome!
- Join our mailing list and get involved with the latest discussions on Eve.
- Impact the future of Eve by getting involved with our Request for Comments process.
- Read our development diary.
- Follow us on twitter.
The best way to contribute right now is to write Eve code and report your experiences. Let us know what kind of programs you’re trying to write, what barriers your are facing in writing code (both mental and technological), and any errors you encounter along the way. Also, let us know what you love! What features are your favorite?
Another way to really help us is to host your *.eve files on Github, so we can get Eve recognized as an official language in the eyes of Github. Be sure to also send us a link to your repo!
Please file any issues in this repository. Before you file an issue, please take a look to see if the issue already exists. When you file an issue, please include:
- The steps needed to reproduce the bug
- Your operating system and browser.
- If applicable, the .*eve file that causes the bug.
Eve is licensed under the Apache 2.0 license, see LICENSE for details.