@pagevitals/pagevitals-cli
v1.1.4
Published
A command-line interface for interacting with the PageVitals API
Downloads
9
Maintainers
Readme
PageVitals CLI
PageVitals CLI is a command-line interface tool for interacting with the PageVitals API, allowing you to run performance tests and manage your PageVitals account from the terminal.
Installation
npm install -g pagevitals-cli
Usage
Setting API Token
Before using the CLI, you need to set your API token. You can do this by running:
pagevitals token <your_api_token>
Note that you can also use the parameter --token
directly in your requests if that suits your workflow better.
Listing Websites
To list all websites associated with your account and their IDs:
pagevitals list-websites
Listing Pages
To list all pages for a specific website:
pagevitals list-pages --website <website_id>
Running Tests
To run performance tests for a website, use the following command:
pagevitals run-tests --website <website_id>
If you want to limit the pages and devices you're testing, use the --page command like this:
pagevitals run-tests --website <website_id> --page <page_id1>,<device1> --page <page_id2,<device2> ...
For more information on available commands, use:
pagevitals --help
Contributing
We welcome contributions! Please read our CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests to us.
License
This project is licensed under the MIT License - see the LICENSE file for details.
About PageVitals
PageVitals is a comprehensive web performance monitoring and optimization platform. Learn more at https://pagevitals.com.
Changelog
For a detailed changelog, please see CHANGELOG.md.
Security
If you discover any security-related issues, please email [email protected] instead of using the issue tracker.