search

Textualize / trogon

Easily turn your Click CLI into a powerful terminal application
MIT License
2.4k stars 54 forks source link

Enhancement request: TUI should display help for arguments (not just parameters) #52

Open barrywhart opened 12 months ago

barrywhart commented 12 months ago

I'm adding Trogon support to a script that uses both arguments and parameters. The click help displays help text for the arguments, e.g.:

python src/airflow_log_search.py mlops-pod-logs --help
╭─ Arguments ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ *    dag                 TEXT              Airflow DAG ID, e.g. recs_sku_coview [default: None] [required]                   │
│ *    task_id             TEXT              Airflow task ID, e.g. predict_batch [default: None] [required]                    │
│      execution_date      [EXECUTION_DATE]  DAG execution date, e.g. 2023-07-06T19:52:45.488702+00:00 [default: None]         │
│      try_number          [TRY_NUMBER]      Task try number, e.g. 1 [default: 1]                                              │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

However, the TUI for the same script does not display the help text for arguments, only for parameters:

image