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

refactor(framework) Order CLI args alphabetically #4923

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

chongshenng
Copy link
Contributor

Sets the help output in flower-superlink, flower-supernode, flwr-serverapp, and flwr-clientapp to be alphabetical. This improves readability.

Example before

➜ flower-supernode -h
usage: flower-supernode [-h] [--insecure] [--grpc-rere | --grpc-adapter | --rest] [--root-certificates ROOT_CERT] [--superlink SUPERLINK] [--max-retries MAX_RETRIES]
                        [--max-wait-time MAX_WAIT_TIME] [--auth-supernode-private-key AUTH_SUPERNODE_PRIVATE_KEY]
                        [--auth-supernode-public-key AUTH_SUPERNODE_PUBLIC_KEY] [--node-config NODE_CONFIG] [--flwr-dir FLWR_DIR] [--isolation {subprocess,process}]
                        [--clientappio-api-address CLIENTAPPIO_API_ADDRESS]

Start a Flower SuperNode

options:
  -h, --help            show this help message and exit
  --insecure            Run the client without HTTPS. By default, the client runs with HTTPS enabled. Use this flag only if you understand the risks.
  --grpc-rere           Use grpc-rere as a transport layer for the client.
  --grpc-adapter        Use grpc-adapter as a transport layer for the client.
  --rest                Use REST as a transport layer for the client.
...

Example after

➜ flower-supernode -h
usage: flower-supernode [--auth-supernode-private-key AUTH_SUPERNODE_PRIVATE_KEY] [--auth-supernode-public-key AUTH_SUPERNODE_PUBLIC_KEY]
                        [--clientappio-api-address CLIENTAPPIO_API_ADDRESS] [--flwr-dir FLWR_DIR] [-h] [--insecure] [--isolation {subprocess,process}]
                        [--max-retries MAX_RETRIES] [--max-wait-time MAX_WAIT_TIME] [--node-config NODE_CONFIG] [--root-certificates ROOT_CERT] [--superlink SUPERLINK]
                        [--grpc-rere | --grpc-adapter | --rest]

Start a Flower SuperNode

options:
  --auth-supernode-private-key AUTH_SUPERNODE_PRIVATE_KEY
                        The SuperNode's private key (as a path str) to enable authentication.
  --auth-supernode-public-key AUTH_SUPERNODE_PUBLIC_KEY
                        The SuperNode's public key (as a path str) to enable authentication.
  --clientappio-api-address CLIENTAPPIO_API_ADDRESS
                        ClientAppIo API (gRPC) server address (IPv4, IPv6, or a domain name). By default, it is set to 0.0.0.0:9094.
  --flwr-dir FLWR_DIR   The path containing installed Flower Apps. The default directory is: - `$FLWR_HOME/` if `$FLWR_HOME` is defined - `$XDG_DATA_HOME/.flwr/` if
                        `$XDG_DATA_HOME` is defined - `$HOME/.flwr/` in all other cases
  -h, --help            show this help message and exit
  --insecure            Run the client without HTTPS. By default, the client runs with HTTPS enabled. Use this flag only if you understand the risks.
...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant