shieldops-cli 1.0.0__py3-none-any.whl

shieldops_cli-1.0.0.dist-info/METADATA

@@ -0,0 +1,351 @@
+Metadata-Version: 2.4
+Name: shieldops-cli
+Version: 1.0.0
+Summary: ShieldOps AI — Security scanner CLI for Docker, Kubernetes, Compose, SBOM, and more.
+Author-email: ShieldOps AI <support@shieldops.ai>
+License: MIT
+Project-URL: Homepage, https://shieldops-ai.onrender.com
+Project-URL: Documentation, https://github.com/mohammedabdallahcv-creator/shieldops-cli
+Project-URL: Repository, https://github.com/mohammedabdallahcv-creator/shieldops-cli
+Project-URL: Changelog, https://github.com/mohammedabdallahcv-creator/shieldops-cli/releases
+Keywords: docker,kubernetes,security,devsecops,sbom,cli
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.1
+Requires-Dist: requests>=2.28
+Requires-Dist: rich>=13.0
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: responses; extra == "dev"
+Provides-Extra: tui
+Requires-Dist: prompt_toolkit>=3.0.43; extra == "tui"
+Dynamic: license-file
+
+# ShieldOps CLI
+
+> AI-powered security scanner for Dockerfiles, Kubernetes, Docker Compose, and more. Scan, fix, and secure your infrastructure from the terminal.
+
+[![PyPI version](https://img.shields.io/pypi/v/shieldops-cli.svg)](https://pypi.org/project/shieldops-cli/)
+[![Python](https://img.shields.io/pypi/pyversions/shieldops-cli.svg)](https://pypi.org/project/shieldops-cli/)
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
+[![GitHub Stars](https://img.shields.io/github/stars/mohammedabdallahcv-creator/shieldops-cli?style=social)](https://github.com/mohammedabdallahcv-creator/shieldops-cli)
+[![Powered by ShieldOps AI](https://img.shields.io/badge/powered%20by-ShieldOps%20AI-8B5CF6)](https://shieldops-ai.onrender.com)
+
+<p align="center">
+  <img src="docs/screenshots/cli-output.svg" alt="ShieldOps CLI in action" width="800">
+</p>
+
+---
+
+## Why ShieldOps CLI
+
+Most Dockerfile/K8s scanners tell you **what** is wrong. ShieldOps CLI also tells you **how to fix it** — using AI that understands your specific configuration, not generic rule text.
+
+| Feature | ShieldOps CLI | Hadolint | Trivy |
+|---|---|---|---|
+| Dockerfile scan | Yes | Yes | Partial |
+| Docker Compose scan | Yes | No | No |
+| K8s manifest scan | Yes | No | Yes |
+| AI-powered autofix | Yes | No | No |
+| SBOM generation | Yes | No | Yes |
+| Compose file generation | Yes | No | No |
+| Docker image scan | Yes | No | Yes (built-in) |
+| Interactive TUI | Yes | No | No |
+| CI/CD ready (`--fail-on`) | Yes | Yes | Yes |
+| Free tier | Yes (5 scans/day) | Yes | Yes |
+
+### What makes it different
+
+1. **AI Autofix** — not just "you have a problem" but "here's your fixed Dockerfile, ready to apply"
+2. **Interactive TUI** — slash-command interface with fuzzy completion, history, and live spinner (think Claude Code but for security scans)
+3. **One tool, many inputs** — Dockerfile, docker-compose.yml, K8s YAML, requirements.txt, package.json, Docker images
+4. **CI/CD gate** — `--fail-on high` exits non-zero in pipelines so bad configs never merge
+
+---
+
+## Quick Start
+
+```bash
+# 1. Install
+pip install shieldops-cli
+
+# 2. Login (free tier — 5 scans/day)
+shieldops login
+
+# 3. Scan your Dockerfile
+shieldops analyze Dockerfile
+```
+
+That's it. You get severity-graded findings, compliance mapping (CIS, SOC 2, NIST), and AI remediation guidance.
+
+---
+
+## Installation
+
+### From PyPI
+
+```bash
+pip install shieldops-cli
+```
+
+### With TUI (interactive terminal)
+
+```bash
+pip install 'shieldops-cli[tui]'
+```
+
+### CI/CD (no TUI)
+
+```bash
+pip install shieldops-cli
+```
+
+---
+
+## Commands
+
+### `analyze` — Dockerfile Security Scan
+
+```bash
+shieldops analyze Dockerfile
+shieldops analyze Dockerfile --format json
+shieldops analyze Dockerfile --fail-on high        # CI/CD gate
+shieldops analyze Dockerfile --open-report         # open browser report
+```
+
+### `autofix` — AI-Powered Dockerfile Fix
+
+```bash
+shieldops autofix Dockerfile                       # see suggested fix
+shieldops autofix Dockerfile --apply               # apply fix in-place (.bak backup)
+shieldops autofix Dockerfile --format json -o fix.json
+```
+
+### `sbom` — Software Bill of Materials
+
+```bash
+shieldops sbom requirements.txt
+shieldops sbom package.json
+shieldops sbom Dockerfile --format json
+```
+
+### `compose-scan` — Docker Compose Scan
+
+```bash
+shieldops compose-scan docker-compose.yml
+shieldops compose-scan docker-compose.yml --fail-on high
+```
+
+### `compose-generate` — Generate Compose from Dockerfile
+
+```bash
+shieldops compose-generate Dockerfile
+shieldops compose-generate Dockerfile --output docker-compose.yml
+```
+
+### `k8s-scan` — Kubernetes Manifest Scan
+
+```bash
+shieldops k8s-scan deployment.yaml
+shieldops k8s-scan pod.yaml --format sarif
+```
+
+### `scan-image` — Docker Image Scan
+
+```bash
+shieldops scan-image nginx:latest
+shieldops scan-image myapp:v1.2.3 --format json
+```
+
+### `login` / `logout` / `whoami`
+
+```bash
+shieldops login                     # interactive prompt
+shieldops login --key sk-...        # direct key
+export SHIELDOPS_API_KEY=sk-...     # or env var (CI/CD)
+shieldops whoami
+shieldops logout
+```
+
+---
+
+## Output Formats
+
+| Format | Best For |
+|---|---|
+| `table` (default) | Terminal reading |
+| `json` | Scripting, API integration |
+| `sarif` | GitHub Security tab, CodeQL |
+| `summary` | One-line pipeline status |
+
+```bash
+shieldops analyze Dockerfile --format json --output scan.json
+shieldops analyze Dockerfile --format sarif --output results.sarif
+shieldops analyze Dockerfile --format summary
+```
+
+---
+
+## TUI — Interactive Terminal Interface
+
+```bash
+shieldops tui
+```
+
+Slash-command interface with fuzzy completion, command history, and live loading spinner:
+
+```
+shieldops> /analyze
+Path to Dockerfile: ./Dockerfile
+Analyzing... [results]
+Completed
+
+shieldops> /autofix
+Path to Dockerfile: ./Dockerfile
+[AI fix suggestions]
+
+shieldops> /save
+Report saved: reports/autofix_20260528_143022.txt
+
+shieldops> /exit
+Session closed.
+```
+
+**Available commands**: `/analyze`, `/autofix`, `/sbom`, `/compose-scan`, `/compose-generate`, `/k8s-scan`, `/scan-image`, `/login`, `/logout`, `/whoami`, `/config`, `/save`, `/help`, `/clear`, `/exit`
+
+Append `-json` to any scan command for JSON output (e.g., `/analyze-json`).
+
+**Tab** = autocomplete, **Up/Down** = history, **/save** = write to file, **/exit** = return to normal terminal for scroll/copy.
+
+---
+
+## CI/CD Integration
+
+### GitHub Actions
+
+```yaml
+name: ShieldOps Security Scan
+on: [push, pull_request]
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install ShieldOps CLI
+        run: pip install shieldops-cli
+      - name: Scan Dockerfile
+        env:
+          SHIELDOPS_API_KEY: ${{ secrets.SHIELDOPS_API_KEY }}
+        run: shieldops analyze Dockerfile --fail-on high --format sarif --output results.sarif
+      - name: Upload SARIF
+        uses: github/codeql-action/upload-sarif@v3
+        with:
+          sarif_file: results.sarif
+```
+
+### GitLab CI
+
+```yaml
+shieldops-scan:
+  image: python:3.11-slim
+  stage: test
+  before_script:
+    - pip install shieldops-cli
+  script:
+    - shieldops analyze Dockerfile --fail-on high --format summary
+  variables:
+    SHIELDOPS_API_KEY: $SHIELDOPS_API_KEY
+```
+
+### Exit Codes
+
+| Code | Meaning |
+|---|---|
+| `0` | Pass — no issues above threshold |
+| `1` | Fail — issues found at or above `--fail-on` severity |
+| `2` | Error — auth, network, or configuration problem |
+
+---
+
+## Free vs Pro
+
+| Feature | Free | Pro |
+|---|---|---|
+| Scans per day | 5 | Unlimited |
+| Dockerfile analysis | Yes | Yes |
+| K8s / Compose scan | Yes | Yes |
+| SBOM | Yes | Yes |
+| AI Autofix | Yes | Yes + `--apply` |
+| Image scan | Yes | Yes |
+| HTML reports | Yes | Yes + PDF |
+| Browser reports | Yes | Yes |
+| Team access | No | Yes |
+| Policy engine | No | Yes |
+| Priority queue | No | Yes |
+
+Get your API key at [shieldops-ai.onrender.com](https://shieldops-ai.onrender.com).
+
+---
+
+## Configuration
+
+```bash
+shieldops config list             # show all settings
+shieldops config set api_url ...  # custom API endpoint
+shieldops config get api_key      # check stored key
+```
+
+Config is stored in `~/.shieldops/config.json`. API keys are stored as-is (encrypt at rest on your machine if needed).
+
+---
+
+## What Runs Where
+
+| Component | Runs Locally | Requires API Key |
+|---|---|---|
+| CLI argument parsing | Yes | No |
+| File reading & validation | Yes | No |
+| Output formatting (table/json/sarif) | Yes | No |
+| Security analysis | No | Yes — sent to ShieldOps AI backend |
+| AI autofix | No | Yes |
+| SBOM generation | No | Yes |
+| Report generation | No | Yes |
+
+The CLI reads your file locally and sends only the file content (never secrets, env vars, or other system data) to the ShieldOps AI backend for analysis. Your file is not stored on our servers beyond the scan session.
+
+---
+
+## Development
+
+```bash
+git clone https://github.com/mohammedabdallahcv-creator/shieldops-cli.git
+cd shieldops-cli
+pip install -e '.[dev]'
+pytest
+```
+
+Run the CLI from source:
+
+```bash
+python -m shieldops_cli.main analyze Dockerfile
+```
+
+---
+
+## License
+
+MIT
+
+---
+
+ShieldOps CLI is open-source. The analysis backend is proprietary and hosted at [shieldops-ai.onrender.com](https://shieldops-ai.onrender.com).

shieldops_cli-1.0.0.dist-info/RECORD

@@ -0,0 +1,26 @@
+shieldops_cli/__init__.py,sha256=XWZSGf8dnDVdBR6-H6oTv27z-Eox5o1xWNHSfv-HmV8,119
+shieldops_cli/api_client.py,sha256=UuFIw0svXWh3Mi315k1tggXozGsF-EX65lJ_wzZuDMI,3994
+shieldops_cli/auth.py,sha256=8HiREyD2MhQsI4VYaOc16EuFOnrWeSvkp5LsxqKefU0,2286
+shieldops_cli/config.py,sha256=EACVTLRY-aDU8qwRYr-prF6vI_OUpb5yIIjamBvQkO4,1386
+shieldops_cli/main.py,sha256=gwq3yYaq_VMRpE1qwwe6UzT_PnMhOx1G9atH5bjMH_c,1485
+shieldops_cli/commands/__init__.py,sha256=kBboS9CwfrhV21yszdAhoKVLwWmC8xYEZneFOHEZRUw,31
+shieldops_cli/commands/analyze.py,sha256=NSdODbquSAQCFaGe56B0rCfEqhj93wuGCAjYgHh-xNw,4011
+shieldops_cli/commands/autofix.py,sha256=qyZXw6KoZMNwJ9cEmHMnl1s6Px1avxIEZtZm5W54Lts,2315
+shieldops_cli/commands/compose_gen.py,sha256=Kwleu9wWFOPQBYM-KIneFXhGXZzAazoiXYAhpVt6XYM,2028
+shieldops_cli/commands/compose_scan.py,sha256=gnGkcYLNcBl0Qa3D420J-MEL-D6UbgZkYIAywrRIvng,2120
+shieldops_cli/commands/config_cmd.py,sha256=_tDIctf7njErsFQKxXpG9iyw5LX6eYEtQxC3rmRKtPA,1268
+shieldops_cli/commands/k8s_scan.py,sha256=9FitPRbl_uyz_Dn24yy3q7XDsU6Hn4druyXXXLygBSw,2649
+shieldops_cli/commands/sbom.py,sha256=RodelbARMrDBr9iVsInAEqX-0iRUbZ2xNgdhbc0_2qA,1551
+shieldops_cli/commands/scan_image.py,sha256=SHn11PKe7YyYd-ScS6cNTNXHXShHZU_OAtv15T1xEEI,4494
+shieldops_cli/commands/tui.py,sha256=MTB4KO2JjMM-S8K6iQzfWP1Gyt4kqc1ssOSbY4v8hSM,741
+shieldops_cli/formatters/__init__.py,sha256=FgJfnkDlz7QUHB3sJe06rXAOEWeH7tzcpzM_u6owIDA,680
+shieldops_cli/formatters/json_fmt.py,sha256=lvPxM5A__rUC3cfGX66DM7947ojNFUXjSJVQ0nEaqs8,156
+shieldops_cli/formatters/sarif.py,sha256=PsqvfluUfQHJ8eopqyDqG9pgFubwuyIPjb5dt_JByHU,2042
+shieldops_cli/formatters/summary.py,sha256=jITqXqSSNwUYWOJDKNX_nCxZCaguW95T7A64bGQ7OOc,1493
+shieldops_cli/formatters/table.py,sha256=BNcUIHe3Ap0ToVuzlp3csVIu8jllkinzuoxki3-oAsQ,8367
+shieldops_cli-1.0.0.dist-info/licenses/LICENSE,sha256=KYUS0m4oNS9bL8lU1plkvjvxJvbWs3oHz8iS0Pyscq4,1069
+shieldops_cli-1.0.0.dist-info/METADATA,sha256=7nVJuiuRwlEs0Z8s8x4SUUAyWLj1KCS0bEPV7mvwD7U,9967
+shieldops_cli-1.0.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+shieldops_cli-1.0.0.dist-info/entry_points.txt,sha256=tjEHeg4I8CD0ET51Ubmtk_xM70F2AGXrD7g7K8-1k9w,53
+shieldops_cli-1.0.0.dist-info/top_level.txt,sha256=dGoQsQLNWDwVfg8B8FG-VEnkrhmPnStZR2V-X3wnNMo,14
+shieldops_cli-1.0.0.dist-info/RECORD,,

shieldops_cli-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

shieldops_cli-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+shieldops = shieldops_cli.main:cli

shieldops_cli-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ShieldOps AI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

shieldops_cli-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+shieldops_cli