Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] npm cli help does not fit the real npm behavior #7402

Closed
2 tasks done
Z9n2JktHlZDmlhSvqc9X2MmL3BwQG7tk opened this issue Apr 22, 2024 · 0 comments · Fixed by #7441
Closed
2 tasks done

[DOCS] npm cli help does not fit the real npm behavior #7402

Z9n2JktHlZDmlhSvqc9X2MmL3BwQG7tk opened this issue Apr 22, 2024 · 0 comments · Fixed by #7441
Assignees
Labels
Documentation documentation related issue Good First Issue good issue or PR for newcomers Priority 2 secondary priority issue

Comments

@Z9n2JktHlZDmlhSvqc9X2MmL3BwQG7tk

Is there an existing issue for this?

  • I have searched the existing issues

This is a CLI Docs Problem, not another kind of Docs Problem.

  • This is a CLI Docs Problem.

Description of Problem

# npm search --help
Search for packages

Usage:
npm search [search terms ...]

Options:
[-l|--long] [--json] [--color|--no-color|--color always] [-p|--parseable]
[--no-description] [--searchopts <searchopts>] [--searchexclude <searchexclude>]
[--registry <registry>] [--prefer-online] [--prefer-offline] [--offline]

aliases: find, s, se

Run "npm help search" for more info

As you can see all parameters are in square brackets, so they are optional.
Doing search:

# npm search --registry=https://my.local.registry
npm ERR! search must be called with arguments

??? With what arguments ? Help does not show any arguments requirement.
Trying another help (as stated by npm itself - Run "npm help search" for more info):

# npm help search
npm ERR! help process exited with code: ENOENT

WTF ??? Where is normal help ?

Versions:
npm-9.8.1
nodejs-18.18.2

Potential Solution

No response

Affected URL

No response

@Z9n2JktHlZDmlhSvqc9X2MmL3BwQG7tk Z9n2JktHlZDmlhSvqc9X2MmL3BwQG7tk added Documentation documentation related issue Needs Triage needs review for next steps labels Apr 22, 2024
@wraithgar wraithgar added Good First Issue good issue or PR for newcomers Priority 2 secondary priority issue and removed Needs Triage needs review for next steps labels Apr 26, 2024
@wraithgar wraithgar self-assigned this Apr 30, 2024
wraithgar added a commit that referenced this issue Apr 30, 2024
`--long` does not do anything and hasn't in some time.
The first search param is also required.

Closes: #7402
Closes: #7434
wraithgar added a commit that referenced this issue Apr 30, 2024
`--long` does not do anything and hasn't in some time.
The first search param is also required.

Closes: #7402
Closes: #7434
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation documentation related issue Good First Issue good issue or PR for newcomers Priority 2 secondary priority issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants