Skip to content

fix: output the general usage of cli #1053

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

Merged
merged 2 commits into from
Dec 25, 2024

Conversation

TwistingTwists
Copy link
Contributor

Fixes #1036

Description

Aims to make CLI more user friendly to use. This PR adds a hint text for indicating how to use API.


This PR has:

  • been tested to ensure log ingestion and log query works.
  • added comments explaining the "why" and the intent of the code wherever would not be obvious for an unfamiliar reader.
  • added documentation for new or modified features or behaviors.

Copy link
Contributor

github-actions bot commented Dec 25, 2024

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@TwistingTwists
Copy link
Contributor Author

TwistingTwists commented Dec 25, 2024

the final output looks like

> ./target/debug/parseable
Parseable v1.6.3

Cloud Native, log analytics platform for modern applications.

Usage:
parseable [command] [options..]


Join the community at https://logg.ing/community.

Commands:
  local-store  Start Parseable with a drive as storage
  s3-store     Start Parseable with S3 or compatible as storage
  blob-store   Start Parseable with Azure Blob storage
  help         Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

@TwistingTwists
Copy link
Contributor Author

I have read the CLA Document and I hereby sign the CLA

@TwistingTwists
Copy link
Contributor Author

recheck

nitisht added a commit to parseablehq/.github that referenced this pull request Dec 25, 2024
@nitisht nitisht requested a review from de-sh December 25, 2024 12:04
Co-authored-by: Nitish Tiwari <[email protected]>
Signed-off-by: Abhishek Tripathi <[email protected]>
@coveralls
Copy link

coveralls commented Dec 25, 2024

Pull Request Test Coverage Report for Build 12492922723

Details

  • 0 of 10 (0.0%) changed or added relevant lines in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage decreased (-0.006%) to 11.489%

Changes Missing Coverage Covered Lines Changed/Added Lines %
src/option.rs 0 10 0.0%
Totals Coverage Status
Change from base Build 12465451984: -0.006%
Covered Lines: 2092
Relevant Lines: 18209

💛 - Coveralls

@nitisht
Copy link
Member

nitisht commented Dec 25, 2024

Skipping CI because this is a text change only.

@nitisht nitisht merged commit d332358 into parseablehq:main Dec 25, 2024
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Help doesn't show all possible arguments
3 participants