pma-cli
v1.0.3
Published
CLI tool for analyzing web pages
Downloads
6
Readme
PMA CLI
Overview
PMA CLI is a powerful command-line tool for analyzing web pages. It provides comprehensive insights into performance metrics, content sizes, and requests made by a web page. This tool can analyze either a URL or local HTML file content, helping developers and web professionals understand and optimize their web page's performance.
Features
- Analyze web pages via URL or local HTML file
- Display detailed performance metrics including page size, load time, and number of requests
- Provide a performance grade based on analysis results
- Organized and easy-to-read output format
- Interactive mode for user-friendly operation
Installation
To install PMA CLI globally, run:
npm install -g pma-cli
Usage
To run the CLI, use the following command in your terminal:
pma [options]
Command Options
-u, --url <url>
: Specify the URL of the web page to analyze-f, --file <filePath>
: Specify the file path of the HTML content to analyze-d, --debug
: Output the process in debug mode-e, --export <filePath>
: Export results to a file-v, --version
: Display the version information-h, --help
: Display command options and usage information
Example Help Output
Interactive Mode
If neither the URL nor the file option is provided, the CLI will enter interactive mode, prompting you to choose between analyzing a URL or HTML content.
Examples
Analyze a URL:
pma --url https://example.com
Analyze a local HTML file:
pma --file /path/to/local/file.html
Analysis Results
After analysis, the results are displayed in a structured format, including:
- Performance Grade: An overall score based on various metrics
- Page Size: Total size of the web page and its resources
- Load Time: Estimated time to load the page
- Number of Requests: Count of HTTP requests made by the page
Example Output
Contributing
We welcome contributions to PMA CLI! Please see our CONTRIBUTING.md file for details on how to get started.
License
This project is licensed under the MIT License. See the LICENSE file for details.
Support
If you encounter any issues or have questions, please file an issue on our GitHub repository.