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

(Documentation request) Document how to run the program with npm #317

Open
hardBSDk opened this issue Jul 25, 2024 · 3 comments
Open

(Documentation request) Document how to run the program with npm #317

hardBSDk opened this issue Jul 25, 2024 · 3 comments

Comments

@hardBSDk
Copy link

It explain how to install the program from the npm servers but not how to run it from this repository.

@SilentBot1
Copy link
Member

Hey @hardBSDk,

Can you clarify what you are requesting in the above?

Do you mean running this via npx, e..g npx webtorrent-cli --help, or do you mean after cloning the git repository locally via node ./bin/cmd.js --help?

@hardBSDk
Copy link
Author

@SilentBot1 npm run

@SilentBot1
Copy link
Member

SilentBot1 commented Aug 20, 2024

Hey @hardBSDk,

The npm run command (an alias of npm run-script) is for running scripts from a package.json as documented here.

webtorrent-cli does not have a npm run command for invoking the CLI, the only supported ways to run the CLI are the already documented ways:

  • npx webtorrent-cli --help
  • npm i -g webtorrent-cli and then webtorrent-cli --help

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

2 participants