geldata / geldata/gel-cli

Repurposed `edgedb info` command for bug-tracking

Open
#892 7 comments 0 reactions 0 assignees View on GitHub
developer experience enhancement needs decision
Dominant language
Rust
Stars
175
Forks
32
PR merge metrics
No merged PRs in 30d

Description

The command should at least report:
1. CLI version and architecture
2. EdgeDB version
3. OS kind and version

Additionally we may try to detect bindings:
* If `Cargo.toml` is present, run `cargo tree`
* If `package.json` is present, run `nmp list...`

I'm not sure how reliable and expected is to run package manager from command, but with the detection, we can try add links where to report bugs:
```
$ edgedb bug-report
Information to paste into bugtracker:
CLI Version: 2.5 x86_64
EdgeDB version: 2.7+deadbee
OS: Windows 10.2 x86_64
Node version: 15.2
edgedb-js version: 2.0.0

Links to report to:
* JavaScript bindings, query builder, data encoding: https://github.com/edgedb/edgedb-js/
* Installation, Administration, REPL: https://github.com/edgedb/edgedb-cli/
* Queries, migration issues, server errors: https://github.com/edgedb/edgedb/
```

Questions:
1. Should we detect languages?
2. Is it okay to have an interactive command? I.e. should we ask interactively if users want's to run `npm` and things?
3. The name: should it be `edgedb bug-report`, `edgedb ver` or `edgedb versions`?

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.