Correct command line usage messages by Low-power · Pull Request #214 · npm/cli

Low-power · 2019-07-16T04:02:07Z

<> should not be used for words that intent to use 'as is'.

Also fixed the on-line usage string of subcommand npm ping.

ljharb · 2019-07-16T04:54:50Z

 npm access restricted [<package>]

- npm access grant <read-only|read-write> <scope:team> [<package>]
+ npm access grant read-only|read-write <scope:team> [<package>]


why not? without the angle brackets it might be confused for being pipes.

No, | should never mean pipe in SYNOPSIS section of manuals or on-line usage message.
Could I understand the < character as the read-open-redirect operator in UNIX shell?

However this change could make the 'or' items be misleading, so please also consider followings:
npm access grant {read-only|read-write} <scope:team> [<package>]
or
npm access grant (read-only|read-write) <scope:team> [<package>]

darcyclarke · 2020-03-18T16:23:31Z

@Low-power appreciate the contribution but we're trying to limit the churn on the 6.x release line at the moment so I'm closing this for now. Feel free to reopen or make changes against the new documentation once we've shipped 7.x.

Low-power · 2019-07-16T04:02:07Z

<> should not be used for words that intent to use 'as is'.

Also fixed the on-line usage string of subcommand npm ping.

ljharb · 2019-07-16T04:54:50Z

 npm access restricted [<package>]

- npm access grant <read-only|read-write> <scope:team> [<package>]
+ npm access grant read-only|read-write <scope:team> [<package>]


why not? without the angle brackets it might be confused for being pipes.

No, | should never mean pipe in SYNOPSIS section of manuals or on-line usage message.
Could I understand the < character as the read-open-redirect operator in UNIX shell?

However this change could make the 'or' items be misleading, so please also consider followings:
npm access grant {read-only|read-write} <scope:team> [<package>]
or
npm access grant (read-only|read-write) <scope:team> [<package>]

darcyclarke · 2020-03-18T16:23:31Z

@Low-power appreciate the contribution but we're trying to limit the churn on the 6.x release line at the moment so I'm closing this for now. Feel free to reopen or make changes against the new documentation once we've shipped 7.x.

Low-power · 2019-07-16T04:02:07Z

<> should not be used for words that intent to use 'as is'.

Also fixed the on-line usage string of subcommand npm ping.

ljharb · 2019-07-16T04:54:50Z

 npm access restricted [<package>]

- npm access grant <read-only|read-write> <scope:team> [<package>]
+ npm access grant read-only|read-write <scope:team> [<package>]


why not? without the angle brackets it might be confused for being pipes.

No, | should never mean pipe in SYNOPSIS section of manuals or on-line usage message.
Could I understand the < character as the read-open-redirect operator in UNIX shell?

However this change could make the 'or' items be misleading, so please also consider followings:
npm access grant {read-only|read-write} <scope:team> [<package>]
or
npm access grant (read-only|read-write) <scope:team> [<package>]

darcyclarke · 2020-03-18T16:23:31Z

@Low-power appreciate the contribution but we're trying to limit the churn on the 6.x release line at the moment so I'm closing this for now. Feel free to reopen or make changes against the new documentation once we've shipped 7.x.

Low-power · 2019-07-16T04:02:07Z

<> should not be used for words that intent to use 'as is'.

Also fixed the on-line usage string of subcommand npm ping.

ljharb · 2019-07-16T04:54:50Z

 npm access restricted [<package>]

- npm access grant <read-only|read-write> <scope:team> [<package>]
+ npm access grant read-only|read-write <scope:team> [<package>]


why not? without the angle brackets it might be confused for being pipes.

No, | should never mean pipe in SYNOPSIS section of manuals or on-line usage message.
Could I understand the < character as the read-open-redirect operator in UNIX shell?

However this change could make the 'or' items be misleading, so please also consider followings:
npm access grant {read-only|read-write} <scope:team> [<package>]
or
npm access grant (read-only|read-write) <scope:team> [<package>]

darcyclarke · 2020-03-18T16:23:31Z

@Low-power appreciate the contribution but we're trying to limit the churn on the 6.x release line at the moment so I'm closing this for now. Feel free to reopen or make changes against the new documentation once we've shipped 7.x.

Low-power · 2019-07-16T04:02:07Z

<> should not be used for words that intent to use 'as is'.

Also fixed the on-line usage string of subcommand npm ping.

ljharb · 2019-07-16T04:54:50Z

 npm access restricted [<package>]

- npm access grant <read-only|read-write> <scope:team> [<package>]
+ npm access grant read-only|read-write <scope:team> [<package>]


why not? without the angle brackets it might be confused for being pipes.

No, | should never mean pipe in SYNOPSIS section of manuals or on-line usage message.
Could I understand the < character as the read-open-redirect operator in UNIX shell?

However this change could make the 'or' items be misleading, so please also consider followings:
npm access grant {read-only|read-write} <scope:team> [<package>]
or
npm access grant (read-only|read-write) <scope:team> [<package>]

darcyclarke · 2020-03-18T16:23:31Z

@Low-power appreciate the contribution but we're trying to limit the churn on the 6.x release line at the moment so I'm closing this for now. Feel free to reopen or make changes against the new documentation once we've shipped 7.x.

Low-power · 2019-07-16T04:02:07Z

<> should not be used for words that intent to use 'as is'.

Also fixed the on-line usage string of subcommand npm ping.

ljharb · 2019-07-16T04:54:50Z

 npm access restricted [<package>]

- npm access grant <read-only|read-write> <scope:team> [<package>]
+ npm access grant read-only|read-write <scope:team> [<package>]


why not? without the angle brackets it might be confused for being pipes.

No, | should never mean pipe in SYNOPSIS section of manuals or on-line usage message.
Could I understand the < character as the read-open-redirect operator in UNIX shell?

However this change could make the 'or' items be misleading, so please also consider followings:
npm access grant {read-only|read-write} <scope:team> [<package>]
or
npm access grant (read-only|read-write) <scope:team> [<package>]

darcyclarke · 2020-03-18T16:23:31Z

@Low-power appreciate the contribution but we're trying to limit the churn on the 6.x release line at the moment so I'm closing this for now. Feel free to reopen or make changes against the new documentation once we've shipped 7.x.

Low-power · 2019-07-16T04:02:07Z

<> should not be used for words that intent to use 'as is'.

Also fixed the on-line usage string of subcommand npm ping.

ljharb · 2019-07-16T04:54:50Z

 npm access restricted [<package>]

- npm access grant <read-only|read-write> <scope:team> [<package>]
+ npm access grant read-only|read-write <scope:team> [<package>]


why not? without the angle brackets it might be confused for being pipes.

No, | should never mean pipe in SYNOPSIS section of manuals or on-line usage message.
Could I understand the < character as the read-open-redirect operator in UNIX shell?

However this change could make the 'or' items be misleading, so please also consider followings:
npm access grant {read-only|read-write} <scope:team> [<package>]
or
npm access grant (read-only|read-write) <scope:team> [<package>]

darcyclarke · 2020-03-18T16:23:31Z

@Low-power appreciate the contribution but we're trying to limit the churn on the 6.x release line at the moment so I'm closing this for now. Feel free to reopen or make changes against the new documentation once we've shipped 7.x.

Low-power · 2019-07-16T04:02:07Z

<> should not be used for words that intent to use 'as is'.

Also fixed the on-line usage string of subcommand npm ping.

ljharb · 2019-07-16T04:54:50Z

 npm access restricted [<package>]

- npm access grant <read-only|read-write> <scope:team> [<package>]
+ npm access grant read-only|read-write <scope:team> [<package>]


why not? without the angle brackets it might be confused for being pipes.

No, | should never mean pipe in SYNOPSIS section of manuals or on-line usage message.
Could I understand the < character as the read-open-redirect operator in UNIX shell?

However this change could make the 'or' items be misleading, so please also consider followings:
npm access grant {read-only|read-write} <scope:team> [<package>]
or
npm access grant (read-only|read-write) <scope:team> [<package>]

darcyclarke · 2020-03-18T16:23:31Z

@Low-power appreciate the contribution but we're trying to limit the churn on the 6.x release line at the moment so I'm closing this for now. Feel free to reopen or make changes against the new documentation once we've shipped 7.x.

Correct usage messages
e87ebde

Low-power requested a review from a team as a code owner July 16, 2019 04:02

ljharb reviewed Jul 16, 2019
View reviewed changes

darcyclarke added the Priority Backlog a "backlogged" item that will be tracked in a Project Board label Nov 19, 2019

darcyclarke added Release 6.x work is associated with a specific npm 6 release semver:patch semver patch level for changes and removed Priority Backlog a "backlogged" item that will be tracked in a Project Board labels Mar 18, 2020

darcyclarke closed this Mar 18, 2020

bumplzz69 mentioned this pull request Nov 30, 2023
[Snyk] Fix for 1 vulnerabilities bumplzz69/cli#38
Open

mtdev2 mentioned this pull request Nov 30, 2023
[Snyk] Fix for 1 vulnerabilities mtdev2/cli#91
Open

Bhanditz mentioned this pull request Nov 30, 2023
[Snyk] Fix for 1 vulnerabilities Bhanditz/cli#29
Open

baby636 mentioned this pull request Dec 1, 2023
[Snyk] Fix for 1 vulnerabilities baby636/cli#62
Open

MrBrain295 mentioned this pull request Dec 19, 2023
[Snyk] Fix for 3 vulnerabilities MrBrain295/cli#12
Open

github-actionsBot added a commit to Kevinlee7250/cli that referenced this pull request Jul 9, 2026
🤖 봇 응답 (npm#214)
7864ef2

github-actionsBot added a commit to Kevinlee7250/cli that referenced this pull request Jul 22, 2026
📊 blog3 게시 완료 (npm#214)
c37c3c4

github-actionsBot added a commit to Kevinlee7250/cli that referenced this pull request Aug 20, 2026
🔥 트렌드 선점 후보 갱신 (npm#214)
4f3fc6a

github-actionsBot added a commit to Kevinlee7250/cli that referenced this pull request Aug 22, 2026
🔧 자동 수리 완료 (npm#214)
c89eb05