getop 1.0.0__tar.gz

getop-1.0.0/.gitignore

@@ -0,0 +1,6 @@
+.venv/
+__pycache__/
+*.egg-info/
+.claude/settings.local.json
+dist/
+getop/_build.py

getop-1.0.0/CHANGELOG.md

@@ -0,0 +1,126 @@
+# Changelog
+
+## [1.0.0](https://github.com/egen/geadm/compare/v0.7.0...v1.0.0) (2026-07-04)
+
+
+### ⚠ BREAKING CHANGES
+
+* command and package are now getop.
+
+### Features
+
+* rename project geadm → getop ([#41](https://github.com/egen/geadm/issues/41)) ([393abc6](https://github.com/egen/geadm/commit/393abc69d848e50a633f29cfc29f285ef51994ff))
+
+## [0.7.0](https://github.com/egen/geadm/compare/v0.6.0...v0.7.0) (2026-07-04)
+
+
+### Features
+
+* **quota:** link quota names to the Cloud console ([#39](https://github.com/egen/geadm/issues/39)) ([f837cc8](https://github.com/egen/geadm/commit/f837cc88258abf196b3063dc06b3524698db19ed))
+
+## [0.6.0](https://github.com/egen/geadm/compare/v0.5.1...v0.6.0) (2026-07-04)
+
+
+### Features
+
+* **cli:** armor --summary aggregates hits by filter ([#37](https://github.com/egen/geadm/issues/37)) ([d22367e](https://github.com/egen/geadm/commit/d22367e483c3cffac3dbb8ba26c618811b5c533f))
+
+## [0.5.1](https://github.com/egen/geadm/compare/v0.5.0...v0.5.1) (2026-07-03)
+
+
+### Bug Fixes
+
+* **cli:** clear update message on PyPI propagation lag ([#35](https://github.com/egen/geadm/issues/35)) ([d981393](https://github.com/egen/geadm/commit/d9813938dc860eb7529a27dcfaa84c7cf65953ba))
+
+
+### Documentation
+
+* **readme:** add roles/modelarmor.viewer ([#33](https://github.com/egen/geadm/issues/33)) ([a6a5372](https://github.com/egen/geadm/commit/a6a53720d71831da519628b65a6ebba20098400c))
+
+## [0.5.0](https://github.com/egen/geadm/compare/v0.4.0...v0.5.0) (2026-07-03)
+
+
+### Features
+
+* **cli:** armor --policy prints the Model Armor template ([#32](https://github.com/egen/geadm/issues/32)) ([430023f](https://github.com/egen/geadm/commit/430023f7a929254c90238c612cc8e3fa143f1f72))
+
+## [0.4.0](https://github.com/egen/geadm/compare/v0.3.2...v0.4.0) (2026-07-03)
+
+
+### Features
+
+* **cli:** add armor command for Model Armor violations ([#30](https://github.com/egen/geadm/issues/30)) ([4245a8d](https://github.com/egen/geadm/commit/4245a8da03c46df414f522d70dc868b2af6e7451))
+
+## [0.3.2](https://github.com/egen/geadm/compare/v0.3.1...v0.3.2) (2026-07-03)
+
+
+### Bug Fixes
+
+* **cli:** force fresh index in update to beat PyPI cache lag ([#28](https://github.com/egen/geadm/issues/28)) ([423b686](https://github.com/egen/geadm/commit/423b68610816b404521f900f4b44b0b6c2cf8b04))
+
+## [0.3.1](https://github.com/egen/geadm/compare/v0.3.0...v0.3.1) (2026-07-03)
+
+
+### Bug Fixes
+
+* **cli:** tighten command help text ([#25](https://github.com/egen/geadm/issues/25)) ([371265a](https://github.com/egen/geadm/commit/371265a64e1d81da156f63e8d059292678030e8a))
+
+## [0.3.0](https://github.com/egen/geadm/compare/v0.2.2...v0.3.0) (2026-07-03)
+
+
+### Features
+
+* **cli:** add update command ([#24](https://github.com/egen/geadm/issues/24)) ([9cc11e7](https://github.com/egen/geadm/commit/9cc11e73ef839eccc0c20d6cb60555d9a6ae117f))
+
+## [0.2.2](https://github.com/egen/geadm/compare/v0.2.1...v0.2.2) (2026-07-03)
+
+
+### Documentation
+
+* **readme:** simpler install, two-engine hero demo ([#22](https://github.com/egen/geadm/issues/22)) ([ce01bbe](https://github.com/egen/geadm/commit/ce01bbeb28db8d25e407622c89bd47addeaad77e))
+
+## [0.2.1](https://github.com/egen/geadm/compare/v0.2.0...v0.2.1) (2026-07-03)
+
+
+### Documentation
+
+* **readme:** add example output for every command ([#21](https://github.com/egen/geadm/issues/21)) ([e8fc35a](https://github.com/egen/geadm/commit/e8fc35a232c05c4ff10b307a09c254cecc7dea69))
+* **readme:** pipx-first install, globals table, auth after commands ([#18](https://github.com/egen/geadm/issues/18)) ([b60c8bc](https://github.com/egen/geadm/commit/b60c8bc23fe5c4fe00501d4d808a40f6491c1d62))
+
+## [0.2.0](https://github.com/egen/geadm/compare/v0.1.1...v0.2.0) (2026-07-03)
+
+
+### Features
+
+* **cli:** add version command with build commit ([#17](https://github.com/egen/geadm/issues/17)) ([737f0e5](https://github.com/egen/geadm/commit/737f0e5b8b0838b45b2c70d3df0a075941972a38))
+
+## [0.1.1](https://github.com/egen/geadm/compare/v0.1.0...v0.1.1) (2026-07-03)
+
+
+### Bug Fixes
+
+* **ci:** harden for public release per BOFH review ([#13](https://github.com/egen/geadm/issues/13)) ([e3fadf0](https://github.com/egen/geadm/commit/e3fadf09a2bfd85d4b29a466e509095fc1cfc769))
+* **cli:** concise help output ([#14](https://github.com/egen/geadm/issues/14)) ([c1f4ee6](https://github.com/egen/geadm/commit/c1f4ee6b68e8f31af8aaad744411a457605e04a7))
+
+## 0.1.0 (2026-07-03)
+
+
+### Features
+
+* **info:** add project overview with per-engine cards ([#8](https://github.com/egen/geadm/issues/8)) ([49b92e2](https://github.com/egen/geadm/commit/49b92e27eff310ba33428bcdbe320c2006f35d6e))
+* **info:** show engine feature toggles and app type on cards ([#10](https://github.com/egen/geadm/issues/10)) ([fad2b5b](https://github.com/egen/geadm/commit/fad2b5b8651a8915af34eb6ac0f7a230dcb9f8a6))
+* **logs:** add gen_ai prompt/response content stream ([#4](https://github.com/egen/geadm/issues/4)) ([432c1c8](https://github.com/egen/geadm/commit/432c1c8bf01b613e72d84dbf81239dcda21b7f7e))
+* **ls:** add user license inventory ([#3](https://github.com/egen/geadm/issues/3)) ([708c173](https://github.com/egen/geadm/commit/708c173af1fcf1a283bc1a49712317362f46a926))
+* **release:** add MIT license, packaging metadata and release pipeline ([#11](https://github.com/egen/geadm/issues/11)) ([308fe11](https://github.com/egen/geadm/commit/308fe11abecafca8daae6d5d853b0323efff9f3e))
+
+
+### Bug Fixes
+
+* **logs:** parse structured gen_ai content payloads ([#6](https://github.com/egen/geadm/issues/6)) ([fa2662c](https://github.com/egen/geadm/commit/fa2662c0b3ee2a6b96d71d938fec10142168c061))
+* **logs:** use non-markup prefixes for gen_ai tool/thought parts ([#7](https://github.com/egen/geadm/issues/7)) ([e40ec55](https://github.com/egen/geadm/commit/e40ec556ac38befa94881276ecc24b3e97a1a519))
+
+
+### Documentation
+
+* **agents:** adopt Conventional Commits ([#5](https://github.com/egen/geadm/issues/5)) ([514a710](https://github.com/egen/geadm/commit/514a710cf82fe863e254c7e223a6a3d15606efb6))
+* **readme:** document geadm info ([#9](https://github.com/egen/geadm/issues/9)) ([4494f56](https://github.com/egen/geadm/commit/4494f5646ea323ca6f16d04d01eac38423c9e99a))

getop-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Egen
+
+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.

getop-1.0.0/PKG-INFO

@@ -0,0 +1,360 @@
+Metadata-Version: 2.4
+Name: getop
+Version: 1.0.0
+Summary: CLI for Google Gemini Enterprise
+Project-URL: Homepage, https://github.com/egen/getop
+Project-URL: Repository, https://github.com/egen/getop
+Project-URL: Issues, https://github.com/egen/getop/issues
+Project-URL: Changelog, https://github.com/egen/getop/blob/main/CHANGELOG.md
+Author: Egen
+Maintainer: Andrew McKinney
+License: MIT
+License-File: LICENSE
+Keywords: agentspace,cli,discovery-engine,gemini-enterprise,google-cloud,observability
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: System :: Monitoring
+Requires-Python: >=3.11
+Requires-Dist: google-cloud-discoveryengine>=0.13
+Requires-Dist: google-cloud-logging>=3.10
+Requires-Dist: google-cloud-monitoring>=2.21
+Requires-Dist: rich>=13.7
+Requires-Dist: typer>=0.12
+Description-Content-Type: text/markdown
+
+# getop
+
+[![Gemini Enterprise](https://img.shields.io/badge/Gemini%20Enterprise-Discovery%20Engine-4285F4?logo=googlecloud&logoColor=white)](https://cloud.google.com/gemini/enterprise)
+[![PyPI](https://img.shields.io/pypi/v/getop)](https://pypi.org/project/getop/)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![Python](https://img.shields.io/badge/python-3.11%2B-3776AB?logo=python&logoColor=white)](https://www.python.org/)
+
+**getop** is a command-line companion for operating **Google Gemini Enterprise**.
+It answers the questions that come up daily while running a deployment — What's
+deployed? Are the connectors syncing? What are users asking, and what is Model
+Armor flagging? How close are we to a quota ceiling? Is everything healthy? — in
+one screen each, straight from your terminal.
+
+```console
+$ getop info
+                     Gemini Enterprise — acme-search-prod (global)
+
+╭─────── Engines ───────╮ ╭───── Data stores ─────╮ ╭────── Connectors ──────╮
+│           2           │ │           9           │ │      3/3 ACTIVE        │
+╰───────────────────────╯ ╰───────────────────────╯ ╰────────────────────────╯
+╭─────── Agents ────────╮ ╭─────── Licenses ──────╮
+│          41           │ │    27/500 (5.4%)      │
+╰───────────────────────╯ │    21/27 logged in    │
+                          │  12 awaiting license  │
+                          ╰───────────────────────╯
+
+╭─────────────── Support Search ───────────────╮ ╭─────────────── Sandbox ──────────────╮
+│ SEARCH · GENERIC · intranet · 2026-04-08     │ │ SEARCH · GENERIC · intranet · 2026-03-26│
+│ Data stores (6)                              │ │ Data stores (3)                        │
+│   • acme-sharepoint_1774543_file ← sharepoint│ │   • acme-sharepoint_1774543_file ← shar…│
+│   • acme-sharepoint_1774543_page ← sharepoint│ │   • acme-onedrive_1775136_file ← onedrive│
+│   • acme-onedrive_1775136_file ← onedrive    │ │   • acme-gdrive_1778773_file ← google_dr…│
+│ Agents (37 — 3 enabled, 34 user defaults)    │ │ Agents (4 — 4 enabled, 0 user defaults)│
+│   • Deep Research ENABLED                    │ │   • Security Reviewer ENABLED          │
+│   • Contract Analyst PRIVATE                 │ │   • Deep Research ENABLED              │
+│   • My Agent ×34 (user defaults, private)    │ │   • Idea Generation ENABLED            │
+│ Features (16 on · 5 off)                     │ │ Features (14 on · 7 off)               │
+│ ✓ agent-gallery model-selector notebook-lm   │ │ ✓ agent-gallery model-selector         │
+│ ✗ agent-sharing-without-admin-approval canvas│ │ ✗ session-sharing onedrive-upload      │
+╰────────── support-search_1775663018 ─────────╯ ╰──────── sandbox_1774543712 ──────────╯
+```
+
+Two engines side by side — spot the config drift at a glance: sandbox has
+`session-sharing` and `onedrive-upload` disabled where prod allows them.
+
+By design, the current release is strictly read-only — every command works with
+viewer roles alone, so it can be handed to anyone on the team without
+change-risk. It may grow administrative verbs (e.g. triggering connector syncs,
+managing agents) in a future release.
+
+Contributing with an AI coding agent? Read [AGENTS.md](AGENTS.md) — it maps the
+project subagents, skills and hard constraints.
+
+## Install
+
+```sh
+pipx install getop
+```
+
+Also works with `uv tool install getop` or `pip install getop`. See
+[Authentication](#authentication) for the one-time credential setup.
+
+## Commands
+
+### `getop info` — project overview
+
+A whole-project dashboard: summary tiles (engines, data stores, connector
+health, agents, and license seats / activation / unmet demand) plus a card per
+engine showing its data stores with their connector sources, its agents ("My
+Agent" user defaults collapsed into a single ×N line), and its feature toggles.
+Diffing two environments' cards is the fastest way to spot config drift. Output
+is shown at the top of this page.
+
+### `getop ls` — inventory
+
+```sh
+getop ls engines|datastores|connectors|agents|licenses
+```
+
+Lists resources across the collection hierarchy: engines and data stores under
+`default_collection`, data connectors across *all* collections (each
+connector-backed source lives in its own), agents per engine, and user licenses.
+
+```console
+$ getop ls connectors
+                               Data Connectors
+┏━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┓
+┃ Collection           ┃ Data Source ┃ State  ┃ Refresh Interval ┃ Entities ┃
+┡━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━┩
+│ acme-sharepoint_1774 │ sharepoint  │ ACTIVE │ 86400s           │ 5        │
+│ acme-onedrive_1775   │ onedrive    │ ACTIVE │ 86400s           │ 1        │
+└──────────────────────┴─────────────┴────────┴──────────────────┴──────────┘
+
+$ getop ls licenses
+                                 User Licenses
+┏━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┓
+┃ User              ┃ State    ┃ Config      ┃ Last Login          ┃
+┡━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━┩
+│ alice@example.com │ ASSIGNED │ enterprise  │ 2026-07-03T12:47:25 │
+│ bob@example.com   │ ASSIGNED │ enterprise  │ 2026-07-03T11:25:22 │
+└───────────────────┴──────────┴─────────────┴─────────────────────┘
+```
+
+### `getop logs` — view and tail logs
+
+```sh
+getop logs connector [--datastore ID] [--severity ERROR] [--since 1h]
+getop logs user [email] [--since 24h] [--follow]
+getop logs ai [--since 24h] [--follow]
+```
+
+`connector` shows data-connector sync activity. `user` shows end-user activity —
+prompts, assistant replies, searches, and Model Armor screening events — for one
+user, or all users when the email is omitted. `ai` streams the raw
+`gen_ai.user.message` / `gen_ai.choice` content logs (no identity field, so it
+can't be scoped per user — use `logs user` for that). `--follow`/`-f` tails
+either stream live. When a log is empty, getop tells you whether logging simply
+isn't enabled on the project or nothing matched your filter.
+
+```console
+$ getop logs user --since 24h
+╭──────────────────────────────── SENSITIVE ─────────────────────────────────╮
+│ ⚠  Output may include end-user prompt/response content if prompt/response   │
+│ logging is enabled on this project.                                         │
+╰─────────────────────────────────────────────────────────────────────────────╯
+                          User activity: all users (24h)
+┏━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┓
+┃ Time     ┃ Severity ┃ User            ┃ Message               ┃ Reply (truncated)   ┃
+┡━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━┩
+│ 16:57:06 │ INFO     │ alice@example.… │ StreamAssist: What's  │ Your travel policy  │
+│          │          │                 │ our travel policy?    │ allows economy fa…  │
+│ 12:49:04 │ WARNING  │ bob@example.com │ ModelArmorAudit:      │                     │
+│          │          │                 │ Ignore all previous…  │                     │
+└──────────┴──────────┴─────────────────┴───────────────────────┴─────────────────────┘
+```
+
+The `WARNING` row is Model Armor flagging a prompt-injection attempt. Tail it
+live with `getop logs user -f`, or pull full transcripts with `--json`.
+
+### `getop armor` — Model Armor violations
+
+```sh
+getop armor [--since 24h] [--all]
+```
+
+Surfaces prompts and responses that Model Armor flagged, with the filters
+that tripped and their confidence (jailbreak, RAI categories, CSAM,
+malicious URIs). Violations only by default; `--all` includes clean
+screenings. Carries no user identity — pair with `getop logs user`.
+
+Add `--summary` for a per-filter rollup — hit counts, last seen, and an example
+input per category — instead of the event-by-event list:
+
+```console
+$ getop armor --summary --since 7d
+              Model Armor hits by filter (7d)
+┏━━━━━━━━━━━━━━━━━━┳━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┓
+┃ Filter           ┃ Hits ┃ Last seen           ┃ Example input       ┃
+┡━━━━━━━━━━━━━━━━━━╇━━━━━━╇━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━┩
+│ pi_and_jailbreak │ 3    │ 2026-07-03T12:49:03 │ Ignore all previou… │
+│ malicious_uris   │ 2    │ 2026-07-03T09:14:00 │ http://testsafebro… │
+└──────────────────┴──────┴─────────────────────┴─────────────────────┘
+```
+
+Add `--policy` to print the configured Model Armor template(s) instead — the
+filters that are enabled and at what confidence:
+
+```console
+$ getop armor --policy
+            Model Armor policy — ge-default-amer (us)
+┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┓
+┃ Filter                            ┃ Enforcement ┃ Confidence       ┃
+┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━┩
+│ Prompt injection & jailbreak      │ ENABLED     │ HIGH             │
+│ Responsible AI: DANGEROUS         │ ENABLED     │ MEDIUM_AND_ABOVE │
+│ Malicious URIs                    │ ENABLED     │                  │
+└───────────────────────────────────┴─────────────┴──────────────────┘
+```
+
+```console
+$ getop armor --since 7d
+                          Model Armor violations (7d)
+┏━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┓
+┃ Time     ┃ Direction ┃ Match       ┃ Filters                   ┃ Content        ┃
+┡━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━┩
+│ 12:49:03 │ prompt    │ MATCH_FOUND │ pi_and_jailbreak(HIGH),   │ Ignore all     │
+│          │           │             │ rai:dangerous(HIGH)       │ previous inst… │
+└──────────┴───────────┴─────────────┴───────────────────────────┴────────────────┘
+```
+
+### `getop stats` — metrics
+
+```sh
+getop stats [--engine ID] [--since 24h]
+```
+
+Discovers the project's `discoveryengine.googleapis.com` metrics at runtime and
+summarises query volume, latency and connector sync freshness over the window.
+
+```console
+$ getop stats --since 24h
+                 Discovery Engine metrics — acme-search-prod (global)
+┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┓
+┃ Metric type                       ┃ Category  ┃ Points ┃ Aggregate           ┃
+┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━┩
+│ …/serving/search_request_count    │ volume    │ 288    │ 1,204 (sum)         │
+│ …/serving/search_latencies        │ latency   │ 288    │ 342 (p95)           │
+│ …/dataconnector/synced_doc_count  │ connector │ 24     │ 48,102 (sum)        │
+└───────────────────────────────────┴───────────┴────────┴─────────────────────┘
+```
+
+### `getop quota` — quota usage
+
+```sh
+getop quota [--since 24h]
+```
+
+Pairs each Discovery Engine quota's latest usage with its limit per location:
+percent used (highlighted at ≥75% / ≥90%), byte quotas in human units, and
+counts of quota-exceeded events over the window — the quickest way to spot the
+next capacity ceiling before ingestion hits it. On terminals that support
+hyperlinks, each quota name links to the project's Cloud console quotas page.
+
+```console
+$ getop quota
+                Discovery Engine quotas — acme-search-prod (global)
+┏━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━┳━━━━━━━━━━┓
+┃ Quota                  ┃ Location ┃ Usage     ┃ Limit      ┃ Used ┃ Exceeded ┃
+┡━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━╇━━━━━━━━━━┩
+│ document_size_tier_st… │ global   │ 85.6 MiB  │ 1.0 GiB    │ 8.4% │          │
+│ data_stores_regional   │ global   │ 8         │ 100        │ 8.0% │          │
+│ documents_regional     │ global   │ 76        │ 10,000,000 │ 0.0% │          │
+└────────────────────────┴──────────┴───────────┴────────────┴──────┴──────────┘
+```
+
+### `getop doctor` — health check
+
+```sh
+getop doctor [--since 24h]
+```
+
+Runs the whole suite concurrently and renders a live PASS/WARN/FAIL table across
+inventory reachability, connector states and sync freshness, connector/API error
+logs, and metric availability. Exits non-zero if any check fails, so it drops
+straight into CI or cron.
+
+```console
+$ getop doctor
+                     getop doctor — acme-search-prod (global)
+┏━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃ Check                  ┃ Status ┃ Detail                                    ┃
+┡━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
+│ engines                │ OK     │ 1 engine(s): support-search               │
+│ datastores             │ OK     │ 6 data store(s)                           │
+│ data connectors        │ OK     │ 2 connector(s), all ACTIVE, synced <24h   │
+│ agents                 │ OK     │ 37 agent(s) across 1 engine(s)            │
+│ connector errors (24h) │ OK     │ no connector ERROR logs since 24h         │
+│ API errors (24h)       │ OK     │ no discoveryengine API ERROR logs         │
+│ monitoring metrics     │ OK     │ 369 metric type(s) discovered             │
+└────────────────────────┴────────┴───────────────────────────────────────────┘
+```
+
+### `getop version`
+
+```console
+$ getop version
+getop 0.2.2 (v0.2.2, commit a1854e8)
+```
+
+Prints the release, tag and the git commit the package was built from.
+
+### `getop update`
+
+```console
+$ getop update
+Update available: 0.2.2 → 0.3.0
+$ pipx upgrade getop
+```
+
+Checks PyPI for a newer release and upgrades in place, detecting whether you
+installed via pipx, uv or pip. Use `--check` to only report.
+
+### Global options
+
+Available on every command:
+
+| Switch | Meaning |
+|---|---|
+| `--project` / `-p` | Target GCP project. Defaults to the ADC project; also reads `GOOGLE_CLOUD_PROJECT`. |
+| `--location` / `-l` | Gemini Enterprise location (default `global`). Regional values route to `{location}-discoveryengine.googleapis.com`. |
+| `--quota-project` | Project to bill API quota against when you lack `serviceusage.services.use` on the target; also reads `GOOGLE_CLOUD_QUOTA_PROJECT`. |
+| `--json` | Machine-readable output on every command (newline-delimited JSON in `--follow` mode). |
+| `--since` | Look-back window on time-based commands: `30m`, `1h`, `24h`, `7d`. |
+
+Every table above is also available as JSON — pipe it straight into `jq`:
+
+```sh
+getop quota --json | jq '.[] | select(.percent_used > 75)'
+getop ls licenses --json | jq '[.[] | select(.last_login_time == null)] | length'
+```
+
+## Authentication
+
+Authenticate once with Application Default Credentials:
+
+```sh
+gcloud auth application-default login
+```
+
+getop never reads or writes key files. Each command needs only a viewer role:
+
+| Role | Used by |
+|---|---|
+| `roles/discoveryengine.viewer` | `getop ls …`, `getop info`, `getop doctor` |
+| `roles/logging.viewer` | `getop logs …`, `getop doctor` |
+| `roles/monitoring.viewer` | `getop stats`, `getop quota`, `getop doctor` |
+| `roles/modelarmor.viewer` | `getop armor --policy` |
+
+User credentials (as opposed to service accounts) also need a quota project:
+getop uses the target project automatically, which requires
+`serviceusage.services.use` there. If you don't have it, use `--quota-project`.
+
+Enabling connector/observability *logging* on a project is a one-time setup
+step requiring `roles/discoveryengine.agentspaceAdmin`; getop only ever reads
+what's there.
+
+## License
+
+MIT © Egen — see [LICENSE](LICENSE).