idank / idank/explainshell

Idea: CLI that replaces flags in a given command with corresponding longer versions

Open
#156 2 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

Love this project. Kudos.

When searching the web for a solution and copy/pasting commands I usually feel comfortable if I can know what the various flags in the command being pasted stand for. I currently paste them into explainshell.com.

But when I want to document the command for my future reference I have to go through a bit of a painful process of matching and replacing the short version of the flags in the command with the longer versions.

Thinking about a solution that could make this easier:

  • A CLI that takes a command with flags as input and prints the command replacing the flags with their longer version

What are your thoughts on this idea?
If this is feasible I would like to give this a try.
If you can provide me some pointers I can poke around.

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 reviewing the existing explainshell command-line entry point and argument-matching behavior. Determine how a pasted command and its flags would be parsed, then define the supported replacement cases and verify that the output preserves the command while expanding flags. No specific files or tests are identified in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.