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

Command line help #22218

Closed
dankrad opened this issue Jan 23, 2021 · 4 comments
Closed

Command line help #22218

dankrad opened this issue Jan 23, 2021 · 4 comments

Comments

@dankrad
Copy link

dankrad commented Jan 23, 2021

The current version of geth gives the following line in the command line help:

   geth [options] command [command options] [arguments...]

Actually, it appears that to start go-ethereum as an Ethereum node, the command argument is left out. This should be documented by showing that command is optional:

   geth [options] [command] [command options] [arguments...]

and adding a line describing this behaviour, e.g. "leaving out the command parameter starts geth as an ethereum node"

It may also be nice to add a "node" command and making this the default behaviour.

@ligi
Copy link
Member

ligi commented Jan 23, 2021

good point actually - fixing via #22220
not yet sure about adding the line describing the behavior as it breaks with the rest of the help layout - but for sure command should be marked optional

@dankrad
Copy link
Author

dankrad commented Jan 23, 2021

not yet sure about adding the line describing the behavior as it breaks with the rest of the help layout - but for sure command should be marked optional

Also consider my suggestion of adding a command "node" to actually start the Ethereum node. I filed this report after staring on the help screen for like 10 minutes and wondering "how to I actually start the node"

@ligi
Copy link
Member

ligi commented Jan 23, 2021

I think this is a great idea - then we could also mark this one as "default"

@fjl
Copy link
Contributor

fjl commented Jan 28, 2021

The documentation is fixed now, but we don't want to add the "node" command. Geth has subcommands for functionality beyond just running the node, but being an Ethereum node is the main thing, and doesn't need a subcommand.

@fjl fjl closed this as completed Jan 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants