idank / idank/explainshell

[feature] Add a simple expand command mode

Open
#266 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
14.2k
Forks
851
PR merge metrics
No merged PRs in 30d

Description

I think current verbose language description is great when you do not know the tool. But if you do know the tool but just need quick reminder what each argument is, it would be great if there would be a way to auto-expand commands. E.g.:

ls -AqQ

Would be converted to:

ls --almost-all --hide-control-chars --quote-name

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the existing verbose command-description flow and the command-line parsing entry point; no specific files or tests are named in the issue. Determine how a separate expand mode should be selected, then verify that short options such as -AqQ are rendered as their long forms while preserving the command's meaning.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.