Skip to content

fix: output the general usage of cli - #1053

Merged
nitisht merged 2 commits into
parseablehq:mainfrom
TwistingTwists:abhi_1036
Dec 25, 2024
Merged

fix: output the general usage of cli#1053
nitisht merged 2 commits into
parseablehq:mainfrom
TwistingTwists:abhi_1036

Conversation

@TwistingTwists

Copy link
Copy Markdown
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.

@github-actions

github-actions Bot commented Dec 25, 2024

Copy link
Copy Markdown
Contributor

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

@TwistingTwists

TwistingTwists commented Dec 25, 2024

Copy link
Copy Markdown
Contributor Author

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
Copy Markdown
Contributor Author

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

@TwistingTwists

Copy link
Copy Markdown
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
Comment thread src/option.rs
Co-authored-by: Nitish Tiwari <nitish@parseable.com>
Signed-off-by: Abhishek Tripathi <abhishek.tripathi456@gmail.com>
@coveralls

coveralls commented Dec 25, 2024

Copy link
Copy Markdown

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

nitisht commented Dec 25, 2024

Copy link
Copy Markdown
Member

Skipping CI because this is a text change only.

@nitisht
nitisht merged commit d332358 into parseablehq:main Dec 25, 2024
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