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

rad env should be renamed to rad environment #8043

Open
rynowak opened this issue Nov 10, 2024 · 3 comments
Open

rad env should be renamed to rad environment #8043

rynowak opened this issue Nov 10, 2024 · 3 comments
Labels
good first issue Good for newcomers triaged This issue has been reviewed and triaged

Comments

@rynowak
Copy link
Contributor

rynowak commented Nov 10, 2024

We should rename rad env to rad environment and provide an alias for rad env.

Take a gander at our CLI help:

Radius CLI

Usage:
  rad [command]

Available Commands:
  application      Manage Radius Applications
  bicep            Manage bicep compiler
  completion       Generates shell completion scripts
  credential       Manage cloud provider credential for a Radius installation.
  debug-logs       Capture logs from Radius control plane for debugging and diagnostics.
  deploy           Deploy a template
  env              Manage Radius Environments
  group            Manage resource groups
  help             Help about any command
  init             Initialize Radius
  install          Installs Radius for a given platform
  recipe           Manage recipes
  resource         Manage resources
  run              Run an application
  uninstall        Uninstall Radius for a specific platform
  version          Prints the versions of the rad cli
  workspace        Manage workspaces

Flags:
      --config string   config file (default "$HOME/.rad/config.yaml")
  -h, --help            help for rad
  -o, --output string   output format (supported formats are json, table) (default "table")

Use "rad [command] --help" for more information about a command.

rad env is the only place we abbreviate.

rad application has the intended design - both rad application and rad app are accepted, but rad application shows up in documentation.

This won't be a breaking change, because the alias will support all of the existing usage.

AB#13668

@ytimocin ytimocin added the triaged This issue has been reviewed and triaged label Nov 11, 2024
@radius-triage-bot
Copy link

👍 We've reviewed this issue and have agreed to add it to our backlog. Please subscribe to this issue for notifications, we'll provide updates when we pick it up.

We also welcome community contributions! If you would like to pick this item up sooner and submit a pull request, please visit our contribution guidelines and assign this to yourself by commenting "/assign" on this issue.

For more information on our triage process please visit our triage overview

@ytimocin ytimocin added the good first issue Good for newcomers label Nov 11, 2024
@radius-triage-bot
Copy link

This issue is a great one to pickup for new contributors. It should only require small changes and not assume a deep knowledge of the Radius architecture.

We always welcome community contributions! If you would like to pick this item up sooner and submit a pull request, please visit our contribution guidelines and assign this to yourself by commenting "/assign" on this issue.

For more information on our triage process please visit our triage overview

@rynowak
Copy link
Contributor Author

rynowak commented Nov 11, 2024

We might also consider doing the same for rad init -> rad initialize.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers triaged This issue has been reviewed and triaged
Projects
None yet
Development

No branches or pull requests

2 participants