https://github.com/geldata/gel-cli
The Gel CLI
https://github.com/geldata/gel-cli
command-line edgedb repl
Last synced: 7 months ago
JSON representation
The Gel CLI
- Host: GitHub
- URL: https://github.com/geldata/gel-cli
- Owner: geldata
- License: apache-2.0
- Created: 2020-03-23T15:17:38.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-06-25T00:26:05.000Z (7 months ago)
- Last Synced: 2025-06-25T01:32:02.772Z (7 months ago)
- Topics: command-line, edgedb, repl
- Language: Rust
- Homepage: https://docs.geldata.com/learn/cli
- Size: 4.62 MB
- Stars: 174
- Watchers: 12
- Forks: 27
- Open Issues: 189
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
Gel Command-line Tools
======================
This repository contains the implementation of `gel` command-line tool.
Install
=======
Install the latest stable build with:
```
curl --proto '=https' --tlsv1.2 -sSfL https://geldata.com/sh | sh
```
Nightly builds can be installed with:
```
$ curl --proto '=https' --tlsv1.2 -sSfL https://geldata.com/sh | sh -s -- --nightly
```
Development
===========
Use cargo for building it:
```
cargo build
cargo run -- --admin -d tutorial
cargo test
```
Tests
=====
There are a few categories of tests in this repo:
- unit tests within `src/`
- run with: `cargo test --bins`,
- no additional requirements,
- `tests/func/`
- invokes the cli binary,
- run with: `cargo test --test=func`,
- requires `gel-server` binary in PATH,
- will use [test-utils](https://github.com/geldata/test-utils/) to start the server,
- `tests/shared-client-tests/`
- generates tests from [shared-client-testcases](https://github.com/geldata/shared-client-testcases/),
- invokes the cli binary,
- run with: `cargo test --package=shared-client-tests`,
- will write into `/home/gel`,
- `tests/portable_*.rs/`
- tests installation of the portable Gel server,
- will download large packages,
- run with: `cargo test --features=portable_tests --test=portable_X`,
- assumes you don't have any portables installed before running it,
- Github Actions & Nightly tests
Code Quality Assurance
======================
This project uses rustfmt and clippy to provide a unified code style.
When opening pull requests, it is advised to run the following commands
before doing so:
```bash
$ cargo clippy --all-features --workspace --all-targets
$ cargo fmt
```
License
=======
Licensed under either of
* Apache License, Version 2.0,
(./LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license (./LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.