nushell/README.md
Stefan Holderbach 1ecbebb24a
Add instructions to run engine-q (#731)
* Add instructions to run engine-q

* Include mention of feature flags
2022-01-14 04:28:35 +11:00

1.3 KiB

Engine-q

Engine-q is an experimental project to replace the core functionality in Nushell (parser, engine, protocol). It's still in an alpha state, and there is still a lot to do: please see TODO.md

Contributing

If you'd like to help out, come join us on the discord or propose some work in an issue or PR draft. We're currently looking to begin porting Nushell commands to engine-q.

If you are interested in porting a command from Nushell to engine-q you are welcome to comment on this issue 242 with the command name you would like to port.

Giving engine-q a test drive

To try out engine-q you need a recent Rust toolchain consisting of the rust compiler and cargo (https://www.rust-lang.org/tools/install).

Switch to a directory where you want to create the directory with engine-q code and clone the repository from github with

git clone https://github.com/nushell/engine-q.git
# Switch to the newly created directory `engine-q` containing the current source code
cd engine-q

Build and run with:

cargo run

For full performance build and run in release mode

cargo run --release

If you also want to have access to all ported plugins including dataframe support you need to enable the extra features with:

cargo run --features extra