Skip to content

Improve CLI help, no-argument error, and README documentation#59

Merged
parvardegr merged 2 commits into
mainfrom
copilot/parvardegrsharing-58-improve-docs
Jun 17, 2026
Merged

Improve CLI help, no-argument error, and README documentation#59
parvardegr merged 2 commits into
mainfrom
copilot/parvardegrsharing-58-improve-docs

Conversation

Copilot AI commented Jun 17, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

The --help output, README, and no-argument error message needed better copy and structure for usability.

CLI (bin/index.js)

  • Usage text: Added a one-line tool description and structured examples (share, clipboard, receive, auth, HTTPS)
  • Option descriptions: Tightened all 14 option descriptions for clarity and consistency
  • No-argument error: Replaced terse "Specify directory or file path." with actionable guidance:
Error: No file or directory specified.

Usage:  sharing <path>       Share a file or directory
        sharing -c           Share clipboard content
        sharing --help       Show all available options

README

  • Rewrote tagline, added a Features section, restructured Getting Started with install/quick-start separation
  • Full --help output block reflecting actual CLI output
  • Tunnel services reformatted as a scannable table
  • Added License section

Improve --help output, no-argument error message, and README document…
40988d2 
…ation

- Rewrite CLI usage text with clear description and structured examples
- Improve all option descriptions for clarity and consistency
- Show helpful usage examples when no arguments are provided
- Rewrite README with professional structure: features list, getting started
  guide, quick start examples, and options reference
- Format tunnel services as a table for better readability
- Add License section

Closes #58
Copilot AI changed the title [WIP] Improve documentation including --help and usage section in README Improve CLI help, no-argument error, and README documentation Jun 17, 2026
Copilot AI requested a review from parvardegr June 17, 2026 04:53
@parvardegr parvardegr marked this pull request as ready for review June 17, 2026 04:56
@parvardegr parvardegr merged commit f22f9dd into main Jun 17, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer
@parvardegr parvardegr parvardegr approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@parvardegr parvardegr

Copilot code review Copilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@parvardegr