# edgedb-cli

**Repository Path**: edgedb/edgedb-cli

## Basic Information

- **Project Name**: edgedb-cli
- **Description**: EdgeDB 的官方命令行工具源码镜像，交流讨论请移步【内宣】库，谢谢！
- **Primary Language**: Rust
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: https://gitee.com/edgedb/devrel
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-08-24
- **Last Updated**: 2025-04-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## 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,

- `tests/docker_test_wrapper.rs`
  - runs other tests in a docker container,
  - run with: `cargo test --features=docker_test_wrapper --test=docker_test_wrapper`,
  - requires Docker,
  - requires that binaries compiled on host machine are runnable in "ubuntu:jammy",

- 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.