# Pingera Platform CLI 🚀
A beautiful Python CLI tool for the [Pingera Platform](https://pingera.ru) - built with typer and rich, distributed via pip and based on Pingera SDK.
[](https://badge.fury.io/py/pingera-cli)
[](https://pypi.org/project/pingera-cli/)
[](https://opensource.org/licenses/MIT)
## ✨ Features
- **Beautiful Terminal Output**: Powered by Rich library for colorful, formatted output
- **Modern CLI Interface**: Built with Typer for intuitive command-line interactions
- **Pingera Platform Integration**: Seamlessly integrates with Pingera SDK for managing and running checks (statuspages and other coming soon)
- **Cross-Platform**: Works on Windows, macOS, and Linux
- **Easy Installation**: Simple pip install with all dependencies managed
- **Configuration Management**: Flexible configuration with environment variables and config files
## 🚀 Installation
Install Pingera Platform CLI using pip:
```bash
pip install pingera-cli
```
## 🔐 Authentication
Before using the CLI, you need to authenticate with the Pingera Platform:
1. **Get your API key**: Visit [app.pingera.ru](https://app.pingera.ru) and create an API token in your account settings
2. **Login to the CLI**:
```bash
pngr auth login --api-key your-api-key-here
```
3. **Verify authentication**:
```bash
pngr auth status
```
Alternatively, you can set the API key as an environment variable:
```bash
export PINGERA_API_KEY=your-api-key-here
```
## 📖 Basic Usage
### List all monitoring checks
```bash
pngr checks list
```
### Get details of a specific check
```bash
pngr checks get <check-id>
```
### Create a new web check
```bash
pngr checks create \
--name "My Website" \
--type web \
--url https://example.com \
--interval 300
```
### Get check results
```bash
pngr checks results <check-id>
```
### Run an on-demand check
```bash
pngr checks run custom \
--type web \
--url https://example.com \
--name "Quick Test"
```
### List available regions
```bash
pngr checks list-regions
```
### Filter regions by check type
```bash
pngr checks list-regions --check-type web
```
## 🔧 Configuration
The CLI stores configuration in `~/.config/pingera-cli/config.json`. You can manage settings with:
```bash
# Show current configuration
pngr config show
# Set default output format
pngr config set output_format json
```
## 📊 Output Formats
The CLI supports multiple output formats:
- **table** (default): Human-readable tables
- **json**: JSON format for scripting
- **yaml**: YAML format
```bash
# JSON output
pngr checks list --output json
# YAML output
pngr checks list --output yaml
```
## 🌐 Platform Links
- **Pingera Platform**: [https://pingera.ru](https://pingera.ru)
- **Web Application**: [https://app.pingera.ru](https://app.pingera.ru)
- **Documentation**: [https://docs.pingera.ru](https://docs.pingera.ru)
## 🛠️ Development
```bash
# Clone the repository
git clone https://github.com/pingera/pingera-cli.git
cd pingera-cli
# Install in development mode
pip install -e .
# Test the CLI (after installation)
pngr --help
# Run tests
python -m pytest tests/
```
## 📝 License
This project is licensed under the MIT License - see the LICENSE file for details.
## 🤝 Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## 📞 Support
- **Issues**: [GitHub Issues](https://github.com/pingera/pingera-cli/issues)
- **Documentation**: [Pingera CLI Docs](https://docs.pingera.ru/devs/cli)
- **Platform Support**: [app.pingera.ru](https://app.pingera.ru)
Raw data
{
"_id": null,
"home_page": "https://github.com/pingera/pingera-cli",
"name": "pingera-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "Pingera Team <privet@pingera.ru>",
"keywords": "cli, pingera, network, monitoring, typer, rich, terminal",
"author": "PingeraCLI Team",
"author_email": "Pingera Team <privet@pingera.ru>",
"download_url": "https://files.pythonhosted.org/packages/f4/24/66bc53a21869455122c33960bfaa1d4967e9c26beeb63326c03af9e3af51/pingera_cli-0.1.2.tar.gz",
"platform": null,
"description": "\n# Pingera Platform CLI \ud83d\ude80\n\nA beautiful Python CLI tool for the [Pingera Platform](https://pingera.ru) - built with typer and rich, distributed via pip and based on Pingera SDK.\n\n[](https://badge.fury.io/py/pingera-cli)\n[](https://pypi.org/project/pingera-cli/)\n[](https://opensource.org/licenses/MIT)\n\n## \u2728 Features\n\n- **Beautiful Terminal Output**: Powered by Rich library for colorful, formatted output\n- **Modern CLI Interface**: Built with Typer for intuitive command-line interactions \n- **Pingera Platform Integration**: Seamlessly integrates with Pingera SDK for managing and running checks (statuspages and other coming soon)\n- **Cross-Platform**: Works on Windows, macOS, and Linux\n- **Easy Installation**: Simple pip install with all dependencies managed\n- **Configuration Management**: Flexible configuration with environment variables and config files\n\n## \ud83d\ude80 Installation\n\nInstall Pingera Platform CLI using pip:\n\n```bash\npip install pingera-cli\n```\n\n## \ud83d\udd10 Authentication\n\nBefore using the CLI, you need to authenticate with the Pingera Platform:\n\n1. **Get your API key**: Visit [app.pingera.ru](https://app.pingera.ru) and create an API token in your account settings\n2. **Login to the CLI**:\n ```bash\n pngr auth login --api-key your-api-key-here\n ```\n3. **Verify authentication**:\n ```bash\n pngr auth status\n ```\n\nAlternatively, you can set the API key as an environment variable:\n```bash\nexport PINGERA_API_KEY=your-api-key-here\n```\n\n## \ud83d\udcd6 Basic Usage\n\n### List all monitoring checks\n```bash\npngr checks list\n```\n\n### Get details of a specific check\n```bash\npngr checks get <check-id>\n```\n\n### Create a new web check\n```bash\npngr checks create \\\n --name \"My Website\" \\\n --type web \\\n --url https://example.com \\\n --interval 300\n```\n\n### Get check results\n```bash\npngr checks results <check-id>\n```\n\n### Run an on-demand check\n```bash\npngr checks run custom \\\n --type web \\\n --url https://example.com \\\n --name \"Quick Test\"\n```\n\n### List available regions\n```bash\npngr checks list-regions\n```\n\n### Filter regions by check type\n```bash\npngr checks list-regions --check-type web\n```\n\n## \ud83d\udd27 Configuration\n\nThe CLI stores configuration in `~/.config/pingera-cli/config.json`. You can manage settings with:\n\n```bash\n# Show current configuration\npngr config show\n\n# Set default output format\npngr config set output_format json\n```\n\n## \ud83d\udcca Output Formats\n\nThe CLI supports multiple output formats:\n\n- **table** (default): Human-readable tables\n- **json**: JSON format for scripting\n- **yaml**: YAML format\n\n```bash\n# JSON output\npngr checks list --output json\n\n# YAML output \npngr checks list --output yaml\n```\n\n## \ud83c\udf10 Platform Links\n\n- **Pingera Platform**: [https://pingera.ru](https://pingera.ru)\n- **Web Application**: [https://app.pingera.ru](https://app.pingera.ru)\n- **Documentation**: [https://docs.pingera.ru](https://docs.pingera.ru)\n\n## \ud83d\udee0\ufe0f Development\n\n```bash\n# Clone the repository\ngit clone https://github.com/pingera/pingera-cli.git\ncd pingera-cli\n\n# Install in development mode\npip install -e .\n\n# Test the CLI (after installation)\npngr --help\n\n# Run tests\npython -m pytest tests/\n```\n\n## \ud83d\udcdd License\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n\n## \ud83e\udd1d Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## \ud83d\udcde Support\n\n- **Issues**: [GitHub Issues](https://github.com/pingera/pingera-cli/issues)\n- **Documentation**: [Pingera CLI Docs](https://docs.pingera.ru/devs/cli)\n- **Platform Support**: [app.pingera.ru](https://app.pingera.ru)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A beautiful Python CLI tool built with typer and rich, distributed via pip and based on Pingera SDK",
"version": "0.1.2",
"project_urls": {
"Bug Tracker": "https://github.com/pingera/pingera-cli/issues",
"Documentation": "https://docs.pingera.com/cli",
"Homepage": "https://github.com/pingera/pingera-cli",
"Repository": "https://github.com/pingera/pingera-cli"
},
"split_keywords": [
"cli",
" pingera",
" network",
" monitoring",
" typer",
" rich",
" terminal"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "cb6a1c3529b9ad0b5091f573d66fa098c4c23a859bea0bb27680eb8965edbcdb",
"md5": "a626681d74503e36e3e2abe20041ea3b",
"sha256": "30082872904f705a1440a900870385f44d3df1224f4cb3c05a8f0b811986303c"
},
"downloads": -1,
"filename": "pingera_cli-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a626681d74503e36e3e2abe20041ea3b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 42612,
"upload_time": "2025-08-28T20:05:09",
"upload_time_iso_8601": "2025-08-28T20:05:09.997892Z",
"url": "https://files.pythonhosted.org/packages/cb/6a/1c3529b9ad0b5091f573d66fa098c4c23a859bea0bb27680eb8965edbcdb/pingera_cli-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "f42466bc53a21869455122c33960bfaa1d4967e9c26beeb63326c03af9e3af51",
"md5": "ad03b1214eb6a14bbc968e9bc188b12a",
"sha256": "7988e727585ea5c3fbeaf3d9602419eb6faea5ddf0a75d187dd1615fbfd6ad6e"
},
"downloads": -1,
"filename": "pingera_cli-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "ad03b1214eb6a14bbc968e9bc188b12a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 51692,
"upload_time": "2025-08-28T20:05:11",
"upload_time_iso_8601": "2025-08-28T20:05:11.116567Z",
"url": "https://files.pythonhosted.org/packages/f4/24/66bc53a21869455122c33960bfaa1d4967e9c26beeb63326c03af9e3af51/pingera_cli-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-28 20:05:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pingera",
"github_project": "pingera-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pingera-cli"
}
JSON
