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.

Sign up for GitHub

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

Jump to bottom

Align cli flags and defaults #369

Closed
corverroos opened this issue Apr 6, 2022 · 5 comments
Closed

Align cli flags and defaults #369

corverroos opened this issue Apr 6, 2022 · 5 comments
Assignees
@corverroos
Labels
enhancement New feature or request

Comments

@corverroos
Copy link
Contributor

Problem to be solved

Some of the charon cli command and flag naming can be improved.

Proposed solution

Suggestions:

  • rename command gen-cluster to create-cluster to avoid acronyms.
  • rename flag p2p-external-host to p2p-external-hostname to make explicit that it isn't a IP but a hostname.
  • Default ports to 1600[1-5] range.
  • Remember to update charon-docker-compose
@corverroos corverroos added the enhancement New feature or request label Apr 6, 2022
@corverroos corverroos self-assigned this Apr 6, 2022
@corverroos corverroos mentioned this issue Apr 6, 2022
Merged
@corverroos
Copy link
Contributor Author

See final result: https://github.com/ObolNetwork/charon/blob/corver/clirefactor/docs/configuration.md

@OisinKyne
Copy link
Contributor

Looks nice and clean!

Some thoughts:

Do we want to plan for a --debug or --dev set of flags where we might keep the things not intended for users?

Do we want to plan for feature flag progression from opt in to opt out? Not sure if that requires any action but I'm basing it off of prysm's approach to gradually bringing new features in https://github.com/prysmaticlabs/prysm/blob/develop/.github/ISSUE_TEMPLATE/feature_flag.md

@dB2510
Copy link
Contributor

dB2510 commented Apr 6, 2022

@OisinKyne I think we should definitely plan for this. It would be extremely important in v1 i suppose. We can create an issue maybe.

obol-bulldozer bot pushed a commit that referenced this issue Apr 7, 2022
@corverroos
cmd: improve naming and defaults (#370)
18d615e 
Improve cli naming. Rename `create-cluster`. Make `p2p-extrernal-hostname` explicit. Align default port range 1600[1-5].

category: refactor
ticket: #369
@corverroos
Copy link
Contributor Author

corverroos commented Apr 7, 2022 •
edited
Loading

We only have --simnet-[beacon|validator]-mock at this point. If we need to add a bunch of dev/debug flags, we could add them to another command debug which extends run with additional flags?

@corverroos
Copy link
Contributor Author

I created this proposal for feature flags: #381

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

@corverroos corverroos

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@OisinKyne @corverroos @dB2510