Azure / azure-dev

A developer CLI that reduces the time it takes for you to get started on Azure. The Azure Developer CLI (azd) provides a set of developer-friendly commands that map to key stages in your workflow - code, build, deploy, monitor, repeat.
https://aka.ms/azd
MIT License
402 stars 195 forks source link

[Issue] `azd show` not listed in output of `azd --help` #1342

Closed bwateratmsft closed 6 months ago

bwateratmsft commented 1 year ago

Output from azd version

azd version 0.4.0-beta.1 (commit 2bf7a529914d86d8e9f5d7b6f95a4f20a2351e01)

Output from az version

{
  "azure-cli": "2.42.0",
  "azure-cli-core": "2.42.0",
  "azure-cli-telemetry": "1.0.8",
  "extensions": {}
}

Describe the bug When running azd --help, the azd show command is not included in the list of commands

To Reproduce

  1. Run azd --help

Expected behavior azd show is listed

Actual behavior It's not:

PS D:\Sandbox\AzdProj> azd --help
Azure Developer CLI is a command-line interface for developers who build Azure solutions.

To begin working with Azure Developer CLI, run the `azd up` command by supplying a sample template in an empty directory:

        $ azd up –-template todo-nodejs-mongo

You can pick a template by running `azd template list`and then supplying the repo name as a value to `--template`.

The most common next commands are:

        $ azd pipeline config
        $ azd deploy
        $ azd monitor --overview

For more information, visit the Azure Developer CLI Dev Hub: https://aka.ms/azure-dev/devhub.

Usage:
  azd [command]

Available Commands:
  config      Manage Azure Developer CLI configuration
  deploy      Deploy the application's code to Azure.
  down        Delete Azure resources for an application.
  env         Manage environments.
  help        Help about any command
  infra       Manage Azure resources.
  init        Initialize a new application.
  login       Log in to Azure.
  monitor     Monitor a deployed application.
  pipeline    Manage GitHub Actions pipelines.
  provision   Provision the Azure resources for an application.
  restore     Restore application dependencies.
  template    Manage templates.
  up          Initialize application, provision Azure resources, and deploy your project with a single command.
  version     Print the version number of Azure Developer CLI.

Flags:
  -C, --cwd string           Sets the current working directory.
      --debug                Enables debugging and diagnostics logging.
  -e, --environment string   The name of the environment to use.
  -h, --help                 Gets help for azd.
      --no-prompt            Accepts the default value instead of prompting, or it fails if there is no default.

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

Please let us know how we are doing: https://aka.ms/azure-dev/hats

Additional context azd show --help does work.

rajeshkamal5050 commented 1 year ago

@bwateratmsft I believe azd show was intentionally kept as an internal command only for VS integration purposes cc: @ellismg

bwateratmsft commented 1 year ago

Ah, I didn't realize that. It seems like something that could be pretty useful for other programmatic integrations though. Maybe not documented on the CLI, but could be elsewhere?

savannahostrowski commented 1 year ago

We have plans to expose this and a human-readable version in Gallium

rajeshkamal5050 commented 1 year ago

@savannahostrowski moving this to Germanium since @gkulin is working on the azd show requirements/UX.

savannahostrowski commented 11 months ago

Related to #1887

rajeshkamal5050 commented 6 months ago

We have added it to the list of commands

azd --help | grep show show : Display information about your app and its resources.