Skip to content
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

README should include the -c flag. #13

Open
FGasper opened this issue Jan 20, 2020 · 0 comments
Open

README should include the -c flag. #13

FGasper opened this issue Jan 20, 2020 · 0 comments

Comments

@FGasper
Copy link

FGasper commented Jan 20, 2020

The current inline help is:

usage: cli.js [-h] [-v] [-l PORT] [-b] [-c] [-R SENDRESIZE] [-r] [-H HEADER]
              [-n] [-k] [-d] [-s SUBP]
              [address]

Positional arguments:
  address

Optional arguments:
  -h, --help            Show this help message and exit.
  -v, --version         Show program's version number and exit.
  -l PORT, --listen PORT
                        Start a websocket server on PORT.
  -b, --binary          Use binary WebSockets.
  -c, --report-close    Write WebSocket $close:$reason to STDERR on close.
  -R SENDRESIZE, --send-resize SENDRESIZE
                        Send text frame when client terminal resizes, using
                        template string containing ${columns} and ${rows}.
  -r, --raw             Use rawmode stdin.
  -H HEADER, --header HEADER
                        Specify a custom HTTP request header. May be given
                        multiple times.
  -n, --no-check        Do not check for unauthorized certificates.
  -k, --keep-open       Do not close the socket after EOF.
  -d, --deflate         Use per-message deflate.
  -s SUBP, --subprotocol SUBP
                        WebSocket subprotocol

… which contains parameters (e.g., -c) that the project’s README doesn’t include.

The same goes for the npmjs.org entry for this project: https://www.npmjs.com/package/wscat2

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

No branches or pull requests

1 participant