Skip to content

feat(cli): Improve UX for key commands with better help, about, and usage examples #10917

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

Open
wants to merge 12 commits into
base: master
Choose a base branch
from

Conversation

MozirDmitriy
Copy link
Contributor

Motivation

The current CLI commands (forge create, forge verify-contract, cast send, cast call) lack detailed help messages, usage examples, and clear argument descriptions. This can make it difficult for both new and experienced users to understand the full capabilities and correct usage of these commands. Improving the UX of the CLI will make Foundry more approachable and user-friendly.

Solution

  • Added or improved about and long_about descriptions for the most important CLI commands.
  • Enhanced help messages for all key arguments and flags, making them more descriptive and actionable.
  • Added value_name for all arguments that accept values, improving clarity in help output.
  • Included real-world usage examples in the long_about or as comments, based on actual CLI syntax and documentation.
  • No changes to logic or behavior—only user-facing descriptions and documentation were improved.

PR Checklist

[ ] Added Tests (N/A: documentation/help only)
[x] Added Documentation (improved CLI help and usage)
[ ] Breaking changes (No breaking changes)

Note:

This PR does not introduce any breaking changes or modify command logic. All changes are focused on improving the CLI user experience through better documentation and help output.

Copy link
Member

@DaniPopes DaniPopes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

help is automatically derived from the doccomment, please remove

@MozirDmitriy
Copy link
Contributor Author

help is automatically derived from the doccomment, please remove

Yes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

2 participants