Skip to content
New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom

Provide ability to navigate directly to online version of help documentation for a command #2867

Closed
gep13 opened this issue Oct 25, 2022 · 2 comments · Fixed by #2868
Closed

Provide ability to navigate directly to online version of help documentation for a command #2867

gep13 opened this issue Oct 25, 2022 · 2 comments · Fixed by #2868
Assignees
@gep13
Labels
5 - Released Improvement
Milestone
2.0.0

Comments

@gep13
Copy link
Member

gep13 commented Oct 25, 2022

Is Your Feature Request Related To A Problem? Please describe.

I believe that there is a lot of output from the choco -h command, and I would like to be able to navigate to the online version of the help documentation, similar to what can be done from PowerShell, for example:

Get-Help Get-Command -Online

Describe The Solution. Why is it needed?

This would make it much easier to get the information I need by reading the online version of the documentation, which is also likely to have the most up to date version of the docs, directly from the command line, without the need to navigate to the docs site.

Additional Context.

N/A

Related Issues

N/A
@corbob
Copy link
Member

corbob commented Oct 25, 2022

Hey @gep13 this is a great idea! How would you like to try your hand at this improvement?

gep13 added a commit to gep13/choco that referenced this issue Oct 25, 2022
@gep13
(chocolatey#2867) Add --online option to all commands
2bbacaa 
This commit adds the --online option to all Chocolatey commands, to
allow opening of the online help documentation for the command that is
being executed.

For example, running:

choco install -h

will output the help documentation to the console, but running:

choco install -h --online

will not output anything to the command line, and instead open the
default browser to the help documentation for the command.
@gep13 gep13 mentioned this issue Oct 25, 2022
Merged
9 tasks
@gep13 gep13 added this to the 2.0.0 milestone Jan 19, 2023
gep13 added a commit to gep13/choco that referenced this issue Apr 13, 2023
@gep13
(chocolatey#2867) Add --online option to all commands
0438eb9 
This commit adds the --online option to all Chocolatey commands, to
allow opening of the online help documentation for the command that is
being executed.

For example, running:

choco install -h

will output the help documentation to the console, but running:

choco install -h --online

will not output anything to the command line, and instead open the
default browser to the help documentation for the command.
gep13 added a commit to gep13/choco that referenced this issue Apr 13, 2023
@gep13
(chocolatey#2867) Add --online option to all commands
536a8f1 
This commit adds the --online option to all Chocolatey commands, to
allow opening of the online help documentation for the command that is
being executed.

For example, running:

choco install -h

will output the help documentation to the console, but running:

choco install -h --online

will not output anything to the command line, and instead open the
default browser to the help documentation for the command.
gep13 added a commit to gep13/choco that referenced this issue Apr 14, 2023
@gep13
(chocolatey#2867) Add --online option to all commands
ea50abd 
This commit adds the --online option to all Chocolatey commands, to
allow opening of the online help documentation for the command that is
being executed.

For example, running:

choco install -h

will output the help documentation to the console, but running:

choco install -h --online

will not output anything to the command line, and instead open the
default browser to the help documentation for the command.
gep13 added a commit to gep13/choco that referenced this issue Apr 14, 2023
@gep13
(chocolatey#2867) Add --online option to all commands
98b9348 
This commit adds the --online option to all Chocolatey commands, to
allow opening of the online help documentation for the command that is
being executed.

For example, running:

choco install -h

will output the help documentation to the console, but running:

choco install -h --online

will not output anything to the command line, and instead open the
default browser to the help documentation for the command.
gep13 added a commit to gep13/choco that referenced this issue Apr 19, 2023
@gep13
(chocolatey#2867) Add --online option to all commands
b16c6fd 
This commit adds the --online option to all Chocolatey commands, to
allow opening of the online help documentation for the command that is
being executed.

For example, running:

choco install -h

will output the help documentation to the console, but running:

choco install -h --online

will not output anything to the command line, and instead open the
default browser to the help documentation for the command.
gep13 added a commit to gep13/choco that referenced this issue Apr 27, 2023
@gep13
(chocolatey#2867) Add --online option to all commands
566b77d 
This commit adds the --online option to all Chocolatey commands, to
allow opening of the online help documentation for the command that is
being executed.

For example, running:

choco install -h

will output the help documentation to the console, but running:

choco install -h --online

will not output anything to the command line, and instead open the
default browser to the help documentation for the command.
gep13 added a commit to gep13/choco that referenced this issue May 2, 2023
@gep13
(chocolatey#2867) Add --online option to all commands
0ad6e7c 
This commit adds the --online option to all Chocolatey commands, to
allow opening of the online help documentation for the command that is
being executed.

For example, running:

choco install -h

will output the help documentation to the console, but running:

choco install -h --online

will not output anything to the command line, and instead open the
default browser to the help documentation for the command.
gep13 added a commit to gep13/choco that referenced this issue May 2, 2023
@gep13
(chocolatey#2867) Add --online option to all commands
ece92e3 
This commit adds the --online option to all Chocolatey commands, to
allow opening of the online help documentation for the command that is
being executed.

For example, running:

choco install -h

will output the help documentation to the console, but running:

choco install -h --online

will not output anything to the command line, and instead open the
default browser to the help documentation for the command.
gep13 added a commit to gep13/choco that referenced this issue May 3, 2023
@gep13
(chocolatey#2867) Add --online option to all commands
1778501 
This commit adds the --online option to all Chocolatey commands, to
allow opening of the online help documentation for the command that is
being executed.

For example, running:

choco install -h

will output the help documentation to the console, but running:

choco install -h --online

will not output anything to the command line, and instead open the
default browser to the help documentation for the command.
gep13 added a commit to gep13/choco that referenced this issue May 3, 2023
@gep13
(chocolatey#2867) Add --online option to all commands
f966315 
This commit adds the --online option to all Chocolatey commands, to
allow opening of the online help documentation for the command that is
being executed.

For example, running:

choco install -h

will output the help documentation to the console, but running:

choco install -h --online

will not output anything to the command line, and instead open the
default browser to the help documentation for the command.
vexx32 added a commit to gep13/choco that referenced this issue May 3, 2023
@vexx32
(chocolatey#2867) Fix wording/spelling of the added comment
8592eb4 
Just tweaking the added comment here to make a little more sense and fix
a typo.
vexx32 added a commit that referenced this issue May 3, 2023
@vexx32
Merge pull request #2868 from gep13/issue2867-help-online
10b95e1 
(#2867) Add --online option to all commands
@vexx32 vexx32 added 4 - Done and removed 3 - Review labels May 8, 2023
@vexx32 vexx32 closed this as completed May 8, 2023
@choco-bot
Copy link

🎉 This issue has been resolved in version 2.0.0 🎉

The release is available on:

Your GitReleaseManager bot 📦🚀

# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees

@gep13 gep13

Labels
5 - Released Improvement
Projects
None yet
Milestone
2.0.0
Development

Successfully merging a pull request may close this issue.

(#2867) Add --online option to all commands gep13/choco
4 participants
@gep13 @choco-bot @corbob @vexx32