META - CLI enhancements

[iameskild]

A lot of work has been put into the new typer-based CLI but there are still a few remaining items that would be nice to include sooner or later.

User experience

Preview Give feedback

1. Move the remaining init input checks closer to the user
2. SSL email check
3. GitHub repo check
4. create check_repository_creds function (similar to check_cloud_provider_creds
5. As more docs are updated and added to nebari.dev, we can add them to the CLI
6. Docs for "advanced configuration changes"
7. Docs for "keycloak" #1743
   +0
8. Unify the styling in a style theme to avoid mismatch and duplication here and there (this can also help us with solving some colour contrast issues)
9. Improve text entry position visibility after verbose outputs and commands
10. Ensure we are adhering to known CLI conventions
11. Replace the -c flag with a more intituive and standard --file/-f flag
12. Alternative render formats (tree view for example
13. Unify y/N questions with an "Enter" key press throughout #1742
    area: nebari-cli good first issue type: enhancement 💅🏼 +3
14. Project name can be eagerly verified to follow cloud provider specific naming convensions
15. [ENH] - Use human-readable cloud providers during guided init #1708
    good first issue needs: PR 📬 type: enhancement 💅🏼 +3
16. re-prompt user during guided init [ENH] - re-prompt user during guided init #1812
17. [ENH] - Nebari CLI should not display a stack trace for expected errors #1946
    area: nebari-cli good first issue needs: discussion 💬 type: bug 🐛 type: enhancement 💅🏼 +5
18. [ENH] - allow to control colors in terminal #2023
    area: user experience 👩🏻‍💻 good first issue type: enhancement 💅🏼 +3

Functional

Preview Give feedback

1. For nebari render, add an option for additional output formats (tree view or simplified table)
2. Adding verbose flag option for deploy / destroy commands (updates to run_subprocess_cmd)
3. project name validation [BUG] - project name validation #1813
4. [BUG] - Nebari init unnecessarily prompts for credentials with --auth-provider Auth0 and GitHub #1935
   area: nebari-cli needs: PR 📬 project: JATIC type: bug 🐛 +4
5. [BUG] - Nebari init with --repository-auto-provision --repository github.com fails on validation error #1936
   area: nebari-cli needs: investigation 🔍 project: JATIC type: bug 🐛 +4
6. [BUG] - Nebari validate with --enable-commenting doesn't do anything #1937
   area: nebari-cli good first issue impact: low 🟩 needs: discussion 💬 type: bug 🐛 +5
7. [BUG] - Nebari init fails with --auth-provider custom #1934
   area: nebari-cli needs: PR 📬 project: JATIC type: bug 🐛 +4
8. [BUG] - nebari upgrade inconsistent behavior around argo_workflows defaults #1964
   area: integration/Argo area: nebari-cli needs: PR 📬 type: bug 🐛 +4
9. [BUG] - nebari upgrade doesn't match -gpu images #1962
   area: nebari-cli project: JATIC type: bug 🐛 +3
10. [BUG] - nebari upgrade incorrect image matching on profiles.dask_worker #1961
    area: nebari-cli project: JATIC type: bug 🐛 +3
11. [BUG] - nebari upgrade prompts for image tag upgrade excessively #1960
    area: nebari-cli type: bug 🐛 +2

Miscellaneous

Preview Give feedback

1. Add tests to the CLI (see META - Extension System Testing #1862)

[iameskild]

• add --disable-checks to nebari deploy
• ensure nebari destroy confirmation prompt works correctly
• ensure that terraform_state is added to config when using nebari init

[pavithraes]

A small, nice-to-have improvement -- For the "y/N" questions, we can wait for the users to press Enter after "y" for consistency with the general flow. I find myself pressing enter out of habit after previous questions, which automatically selects an answer for the next question. This means I need to restart the guided init from the beginning.

[trallard]

Now that we have tasklists in the org I reorganised all the tasks in the meta issue above cc/ @pavithraes @iameskild

[pavithraes]

@iameskild @trallard Some of the tasks here can be good first issues, so converting them into separate issue with the GFI tags. :)

The mentored sprint at PyCon US 2023 is prompting this decision, but it can be useful for future sprints too. :)