FR: usage integration
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 24.1k
- Forks
- 2k
- Avg merge
- 1d 5h
- Merged PRs (30d)
- 365
Description
I'm the maintainer of https://usage.jdx.dev/. It's a mature project by jdx, the author of mise. It's generally a schema for CLI tools. The schema can be generated from clap (by https://crates.io/crates/clap_usage), and everyone can consume the schema and generate Markdown pages, manpages, completions (for all shells, better than existing clap_complete), JSON schemas and even Python / TypeScript / Rust type-safe SDKs (see here).
With this integration, the wonderful coreutils project will have better auto-generated docs, completions, etc. Do you have interest on it? If so, I can submit a PR for it!
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue names no coreutils files, tests, or entry points. Start by reading the linked usage.jdx documentation and reviewing how coreutils currently defines CLI interfaces, then clarify which integration outputs are in scope. Done requires an agreed integration target and a submitted pull request.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- cli, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100