drizzle-team / drizzle-team/drizzle-orm

[DOCS]: Improve CLI --help output

Open
#4,094 0 comments 0 reactions 0 assignees View on GitHub
docs docs/improvements drizzle/kit improvement
Dominant language
TypeScript
Stars
35.8k
Forks
1.6k
Avg merge
2d 7h
Merged PRs (30d)
4

Description

### Enhancement hasn't been filed before.

- [x] I have verified this enhancement I'm about to request hasn't been suggested before.

### Describe the enhancement you want to request

Image

## Improve CLI --help Output with Command Descriptions

### Description

I’d like to suggest an improvement to the CLI `--help` output for drizzle-kit. Currently, the commands do not include descriptions, making it slightly challenging to understand the functionality at a glance. Adding brief descriptions would significantly enhance usability by providing immediate context.

As someone new to ORMs, I found it challenging to understand commands like `push` and `migrate` just from their names. While `studio` is intuitive, a short explanation in the `--help` output would make it much easier to grasp their purpose without needing to search elsewhere.

### Proposal

Add one-line descriptions to each drizzle-kit command in the `--help` output.
Ensure that common commands like push and migrate are clearly explained.

## Contribution

I’d be happy to work on this if the change is welcome. Just wanted to check in first to see if this is something you'd be open to.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.