ballerina-platform / ballerina-lang

The Ballerina Programming Language
https://ballerina.io/
Apache License 2.0
3.68k stars 752 forks source link

[Improvement]: Improve the CLI command outputs #43428

Open azinneera opened 1 month ago

azinneera commented 1 month ago

Description

Watched a video tutorial on YT and noticed some hiccups in the CLI user experience. IMO, the CLI help text can be more intuitive in guiding the user throughout the build process. For example, we can add a What's next as the last part of the command output. This has already been added for the bal build --cloud=docker. We should update the other commands also as follows:

Command
What’s Next
bal new <package-name>

bal new <package-name> -t main
Execute bal run <package-name> to run the program

Execute bal build <package-name> to build the executable JAR
bal new <package-name> -t service Execute bal run <package-name> to run the service

Execute bal build <package-name> to build the executable JAR
bal new <package-name> -t lib Execute bal pack <package-name> to create the Ballerina archive
bal build Execute java -jar <relative-path-to-the-executable-file> to run the program
bal pack Execute bal push to publish the package to Ballerina Central.

Describe your problem(s)

No response

Describe your solution(s)

No response

Related area

-> Compilation

Related issue(s) (optional)

No response

Suggested label(s) (optional)

No response

Suggested assignee(s) (optional)

No response

tanbirali commented 1 month ago

I will like to take this up

azinneera commented 1 month ago

Hi @tanbirali

You can work on this issue.

To help you get started, here are some essential resources:

  1. Understanding the Ballerina platform Learn what Ballerina is all about: Ballerina Platform
  2. How to Contribute Read our contribution guidelines to understand how you can contribute effectively: Contribution Guide
  3. Contributing to the Ballerina library If you're interested in contributing to the Ballerina library, here are the guidelines: Library Contribution Guide
  4. Learn Ballerina If you're new to Ballerina or want to enhance your skills, our official website offers a wealth of learning resources: Learn Ballerina
  5. Get Help and Connect: Ask technical questions on Stack Overflow with with ballerina tag and join our Discord community Ballerina Discord