qualys-cli 0.1.1__tar.gz → 0.1.3__tar.gz

{qualys_cli-0.1.1 → qualys_cli-0.1.3}/CHANGELOG.md

@@ -6,6 +6,35 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+## [0.1.3] — 2026-07-08
+
+### Added
+- `ca agent list` and `ca agent count` now accept `--status Active|Inactive`,
+  mapped to the Qualys `agentInfo.status` (`STATUS_ACTIVE`/`STATUS_INACTIVE`)
+  search criterion.
+- `qualys-cli docs` command — locates or opens the bundled HTML command
+  reference that ships inside the package (`--open`/`--no-open`/`--stdout`).
+  The sub-app existed but was never registered on the CLI.
+
+### Fixed
+- `asset ip add` failed with HTTP 400 because it never sent a module flag. It
+  now sends `enable_vm=1` by default and exposes `--vm/--no-vm`, `--pc`,
+  `--sca`, and `--certview` (at least one is required by the API).
+- `vm option-profile delete` sent the profile ID under `ids`; the API requires
+  the singular `id`, so deletes returned HTTP 400.
+- `user create` never sent `action=add`, which the `/msp/user.php` API requires
+  to create a user.
+- `pm job create` and `pm job update` now send the API-required `type` field;
+  `pm job change-status` posts job IDs under `ids` (was the wrong key `jobIds`).
+- Corrected the README instructions for locating the bundled usage reference
+  (the old `sys.prefix/share/...` path was never where the file shipped).
+
+## [0.1.2] — 2026-07-08
+
+### Changed
+- Metadata-only republish: simplified `[project.urls]`/description in
+  `pyproject.toml`. No functional changes from 0.1.1.
+
 ## [0.1.1] — 2026-07-08
 
 ### Security
@@ -102,6 +131,7 @@ Initial public release.
 - Ruff lint clean (E, F, I, UP, B, C4, SIM rule sets).
 - Codegen pipeline (`scripts/`) is opt-in via the `codegen` extra.
 
-[Unreleased]: https://github.com/qualys/qualys-cli/compare/v0.1.1...HEAD
+[Unreleased]: https://github.com/qualys/qualys-cli/compare/v0.1.2...HEAD
+[0.1.2]: https://github.com/qualys/qualys-cli/compare/v0.1.1...v0.1.2
 [0.1.1]: https://github.com/qualys/qualys-cli/compare/v0.1.0...v0.1.1
 [0.1.0]: https://github.com/qualys/qualys-cli/releases/tag/v0.1.0

{qualys_cli-0.1.1 → qualys_cli-0.1.3}/PKG-INFO

@@ -1,11 +1,8 @@
 Metadata-Version: 2.4
 Name: qualys-cli
-Version: 0.1.1
-Summary: Command-line interface for the Qualys REST APIs (VM, PC, PM, ETM, WAS, TC, CA, CS, CSAM, Sub, Asset, User).
-Project-URL: Homepage, https://github.com/qualys/qualys-cli
-Project-URL: Documentation, https://github.com/qualys/qualys-cli#readme
-Project-URL: Issues, https://github.com/qualys/qualys-cli/issues
-Project-URL: Changelog, https://github.com/qualys/qualys-cli/blob/main/CHANGELOG.md
+Version: 0.1.3
+Summary: Unified command-line interface for the Qualys Cloud Platform REST APIs (VM, PC, PM, ETM, WAS, TotalCloud, Cloud Agent, Container Security, CSAM, Subscription, Asset, and User management).
+Project-URL: Homepage, https://www.qualys.com
 Author: qualys-cli contributors
 License: MIT License
         
@@ -67,17 +64,16 @@ Description-Content-Type: text/markdown
 
 # qualys-cli
 
-[![CI](https://github.com/qualys/qualys-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/qualys/qualys-cli/actions/workflows/ci.yml)
 [![PyPI](https://img.shields.io/pypi/v/qualys-cli.svg)](https://pypi.org/project/qualys-cli/)
 [![Python](https://img.shields.io/pypi/pyversions/qualys-cli.svg)](https://pypi.org/project/qualys-cli/)
-[![License](https://img.shields.io/pypi/l/qualys-cli.svg)](LICENSE)
+[![License](https://img.shields.io/pypi/l/qualys-cli.svg)](https://pypi.org/project/qualys-cli/)
 
-A unified command-line interface for the Qualys REST APIs — covering VM, PC,
-Patch Management, ETM, WAS, TotalCloud (TC), Cloud Agent (CA), Container
-Security (CS), CSAM, Subscription, Asset, and User management. Rich table
-output, JSON / YAML / JSONL export, automatic retry with backoff, JWT auto-
-refresh, OS-keyring credential storage, and a clean machine-readable mode for
-scripting and AI agents.
+A unified command-line interface for the Qualys Cloud Platform REST APIs —
+covering VM, PC, Patch Management, ETM, WAS, TotalCloud (TC), Cloud Agent (CA),
+Container Security (CS), CSAM, Subscription, Asset, and User management. Rich
+table output, JSON / YAML / JSONL export, automatic retry with backoff, JWT
+auto-refresh, OS-keyring credential storage, and a clean machine-readable mode
+for scripting and AI agents.
 
 ```text
   ╭─────────────────────────────────────────────────╮
@@ -87,22 +83,17 @@ scripting and AI agents.
   ╰─────────────────────────────────────────────────╯
 ```
 
-## Install
+## Installation
 
 ```bash
-# End user (recommended)
+# Recommended — isolated install
 pipx install qualys-cli
 
-# Or from source
-pipx install git+https://github.com/qualys/qualys-cli
-
-# Development
-git clone https://github.com/qualys/qualys-cli && cd qualys-cli
-uv sync
-uv run qualys-cli --help
+# Or into the current environment
+pip install qualys-cli
 ```
 
-Python 3.11+ required. Works on macOS, Linux, and Windows.
+Python 3.11 or newer. Works on macOS, Linux, and Windows.
 
 ## Quick start
 
@@ -116,7 +107,7 @@ qualys-cli was webapp list
 qualys-cli pm job list --format json
 ```
 
-### Non-interactive setup (CI / Docker)
+### Non-interactive setup
 
 ```bash
 qualys-cli configure \
@@ -137,9 +128,9 @@ Multiple profiles via `--profile <name>` or `QUALYS_PROFILE`. List with `qualys-
 
 The CLI has two top-level modes that govern the *default* output style:
 
-| Mode          | Default output                  | Spinners / colours | Use case                     |
-|---------------|---------------------------------|--------------------|------------------------------|
-| `interactive` | Rich table (first 25 rows)      | Yes                | Humans in a terminal         |
+| Mode          | Default output                  | Spinners / colours | Use case                      |
+|---------------|---------------------------------|--------------------|-------------------------------|
+| `interactive` | Rich table (first 25 rows)      | Yes                | Humans in a terminal          |
 | `agentic`     | JSON, no decoration             | No                 | Scripts, pipelines, AI agents |
 
 Switch the persistent default for a profile:
@@ -156,15 +147,15 @@ Or set per-shell with `export QUALYS_OUTPUT_MODE=agentic`.
 
 These work on every command and override the mode default:
 
-| Flag                          | Behaviour                                                      |
-|-------------------------------|----------------------------------------------------------------|
-| `--format json`               | Full JSON to stdout                                            |
-| `--format jsonl`              | One flattened JSON object per line (JSON Lines / NDJSON)       |
-| `--format yaml`               | YAML to stdout                                                 |
-| `--format table`              | Rich table (forced)                                            |
-| `--limit 0`                   | Remove the default 25-row cap                                  |
-| `--output-file results.json`  | Dump full data to file (extension picks JSON or YAML)          |
-| `-v`, `-vv`                   | Log requests (and response sizes); secrets never logged        |
+| Flag                          | Behaviour                                                     |
+|-------------------------------|--------------------------------------------------------------|
+| `--format json`               | Full JSON to stdout                                          |
+| `--format jsonl`              | One flattened JSON object per line (JSON Lines / NDJSON)     |
+| `--format yaml`               | YAML to stdout                                               |
+| `--format table`              | Rich table (forced)                                         |
+| `--limit 0`                   | Remove the default 25-row cap                               |
+| `--output-file results.json`  | Dump full data to file (extension picks JSON or YAML)       |
+| `-v`, `-vv`                   | Log requests (and response sizes); secrets never logged     |
 
 ## Examples by module
 
@@ -226,15 +217,16 @@ qualys-cli user create --username jdoe --first-name Jane --last-name Doe \
 Tip: append `--help` to any command (e.g. `qualys-cli was scan launch --help`)
 for the full flag set.
 
-## Documentation
+## Bundled documentation
 
-A comprehensive usage reference with all 273 endpoints is included in the package:
-- **Source install**: `docs/usage.html` in the repository
-- **Pip install**: Located in your Python environment's `share/qualys-cli/docs/usage.html`
+A comprehensive HTML usage reference covering every command ships inside the
+package. The `docs` command finds and opens it — no path guessing required, and
+it works identically for `pip` and `pipx` installs:
 
-To find it after installation:
 ```bash
-python -c "import sys; print(sys.prefix + '/share/qualys-cli/docs/usage.html')"
+qualys-cli docs              # open the reference in your default browser
+qualys-cli docs --no-open    # just print the file path (and size)
+qualys-cli docs --stdout     # write the raw HTML to stdout (pipe it anywhere)
 ```
 
 ## LLM / agent usage
@@ -274,46 +266,6 @@ qualys-cli --profile nonexistent vm host list 2>/tmp/err.json
 JWT tokens are fetched via `POST /auth`, cached in `config.toml`, and
 auto-refreshed on 401.
 
-## Development
-
-```bash
-uv sync
-uv run pytest                # tests
-uv run ruff check src/       # lint
-uv run mypy src/             # type check
-uv run qualys-cli --help     # smoke
-uv build                     # build sdist + wheel into dist/
-```
-
-### Regenerating commands from Qualys docs
-
-The codegen pipeline is opt-in via the `codegen` extra (it pulls in
-`anthropic`, `trafilatura`, `selectolax`, `pypdf`):
-
-```bash
-uv sync --extra codegen
-export ANTHROPIC_API_KEY=sk-ant-...
-uv run scripts/ingest_docs.py        # cache HTML pages
-uv run scripts/extract_endpoints.py  # LLM extraction → api-model.json
-uv run scripts/generate_commands.py  # regenerate commands/*.py
-```
-
-Generated files are marked with `# Auto-generated from api-model.json` and are
-safe to overwrite. Files without that header are treated as hand-edited and
-left alone.
-
-## Releasing
-
-Releases are published to PyPI by GitHub Actions on a tag push:
-
-```bash
-# Bump version in pyproject.toml, update CHANGELOG.md, commit
-git tag v0.1.1 && git push --tags
-```
-
-PyPI publishing uses Trusted Publishing (OIDC) — no API token is stored.
-Configure once at https://pypi.org/manage/project/qualys-cli/settings/publishing/.
-
 ## License
 
-[MIT](LICENSE)
+MIT

{qualys_cli-0.1.1 → qualys_cli-0.1.3}/README.md

@@ -1,16 +1,15 @@
 # qualys-cli
 
-[![CI](https://github.com/qualys/qualys-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/qualys/qualys-cli/actions/workflows/ci.yml)
 [![PyPI](https://img.shields.io/pypi/v/qualys-cli.svg)](https://pypi.org/project/qualys-cli/)
 [![Python](https://img.shields.io/pypi/pyversions/qualys-cli.svg)](https://pypi.org/project/qualys-cli/)
-[![License](https://img.shields.io/pypi/l/qualys-cli.svg)](LICENSE)
+[![License](https://img.shields.io/pypi/l/qualys-cli.svg)](https://pypi.org/project/qualys-cli/)
 
-A unified command-line interface for the Qualys REST APIs — covering VM, PC,
-Patch Management, ETM, WAS, TotalCloud (TC), Cloud Agent (CA), Container
-Security (CS), CSAM, Subscription, Asset, and User management. Rich table
-output, JSON / YAML / JSONL export, automatic retry with backoff, JWT auto-
-refresh, OS-keyring credential storage, and a clean machine-readable mode for
-scripting and AI agents.
+A unified command-line interface for the Qualys Cloud Platform REST APIs —
+covering VM, PC, Patch Management, ETM, WAS, TotalCloud (TC), Cloud Agent (CA),
+Container Security (CS), CSAM, Subscription, Asset, and User management. Rich
+table output, JSON / YAML / JSONL export, automatic retry with backoff, JWT
+auto-refresh, OS-keyring credential storage, and a clean machine-readable mode
+for scripting and AI agents.
 
 ```text
   ╭─────────────────────────────────────────────────╮
@@ -20,22 +19,17 @@ scripting and AI agents.
   ╰─────────────────────────────────────────────────╯
 ```
 
-## Install
+## Installation
 
 ```bash
-# End user (recommended)
+# Recommended — isolated install
 pipx install qualys-cli
 
-# Or from source
-pipx install git+https://github.com/qualys/qualys-cli
-
-# Development
-git clone https://github.com/qualys/qualys-cli && cd qualys-cli
-uv sync
-uv run qualys-cli --help
+# Or into the current environment
+pip install qualys-cli
 ```
 
-Python 3.11+ required. Works on macOS, Linux, and Windows.
+Python 3.11 or newer. Works on macOS, Linux, and Windows.
 
 ## Quick start
 
@@ -49,7 +43,7 @@ qualys-cli was webapp list
 qualys-cli pm job list --format json
 ```
 
-### Non-interactive setup (CI / Docker)
+### Non-interactive setup
 
 ```bash
 qualys-cli configure \
@@ -70,9 +64,9 @@ Multiple profiles via `--profile <name>` or `QUALYS_PROFILE`. List with `qualys-
 
 The CLI has two top-level modes that govern the *default* output style:
 
-| Mode          | Default output                  | Spinners / colours | Use case                     |
-|---------------|---------------------------------|--------------------|------------------------------|
-| `interactive` | Rich table (first 25 rows)      | Yes                | Humans in a terminal         |
+| Mode          | Default output                  | Spinners / colours | Use case                      |
+|---------------|---------------------------------|--------------------|-------------------------------|
+| `interactive` | Rich table (first 25 rows)      | Yes                | Humans in a terminal          |
 | `agentic`     | JSON, no decoration             | No                 | Scripts, pipelines, AI agents |
 
 Switch the persistent default for a profile:
@@ -89,15 +83,15 @@ Or set per-shell with `export QUALYS_OUTPUT_MODE=agentic`.
 
 These work on every command and override the mode default:
 
-| Flag                          | Behaviour                                                      |
-|-------------------------------|----------------------------------------------------------------|
-| `--format json`               | Full JSON to stdout                                            |
-| `--format jsonl`              | One flattened JSON object per line (JSON Lines / NDJSON)       |
-| `--format yaml`               | YAML to stdout                                                 |
-| `--format table`              | Rich table (forced)                                            |
-| `--limit 0`                   | Remove the default 25-row cap                                  |
-| `--output-file results.json`  | Dump full data to file (extension picks JSON or YAML)          |
-| `-v`, `-vv`                   | Log requests (and response sizes); secrets never logged        |
+| Flag                          | Behaviour                                                     |
+|-------------------------------|--------------------------------------------------------------|
+| `--format json`               | Full JSON to stdout                                          |
+| `--format jsonl`              | One flattened JSON object per line (JSON Lines / NDJSON)     |
+| `--format yaml`               | YAML to stdout                                               |
+| `--format table`              | Rich table (forced)                                         |
+| `--limit 0`                   | Remove the default 25-row cap                               |
+| `--output-file results.json`  | Dump full data to file (extension picks JSON or YAML)       |
+| `-v`, `-vv`                   | Log requests (and response sizes); secrets never logged     |
 
 ## Examples by module
 
@@ -159,15 +153,16 @@ qualys-cli user create --username jdoe --first-name Jane --last-name Doe \
 Tip: append `--help` to any command (e.g. `qualys-cli was scan launch --help`)
 for the full flag set.
 
-## Documentation
+## Bundled documentation
 
-A comprehensive usage reference with all 273 endpoints is included in the package:
-- **Source install**: `docs/usage.html` in the repository
-- **Pip install**: Located in your Python environment's `share/qualys-cli/docs/usage.html`
+A comprehensive HTML usage reference covering every command ships inside the
+package. The `docs` command finds and opens it — no path guessing required, and
+it works identically for `pip` and `pipx` installs:
 
-To find it after installation:
 ```bash
-python -c "import sys; print(sys.prefix + '/share/qualys-cli/docs/usage.html')"
+qualys-cli docs              # open the reference in your default browser
+qualys-cli docs --no-open    # just print the file path (and size)
+qualys-cli docs --stdout     # write the raw HTML to stdout (pipe it anywhere)
 ```
 
 ## LLM / agent usage
@@ -207,46 +202,6 @@ qualys-cli --profile nonexistent vm host list 2>/tmp/err.json
 JWT tokens are fetched via `POST /auth`, cached in `config.toml`, and
 auto-refreshed on 401.
 
-## Development
-
-```bash
-uv sync
-uv run pytest                # tests
-uv run ruff check src/       # lint
-uv run mypy src/             # type check
-uv run qualys-cli --help     # smoke
-uv build                     # build sdist + wheel into dist/
-```
-
-### Regenerating commands from Qualys docs
-
-The codegen pipeline is opt-in via the `codegen` extra (it pulls in
-`anthropic`, `trafilatura`, `selectolax`, `pypdf`):
-
-```bash
-uv sync --extra codegen
-export ANTHROPIC_API_KEY=sk-ant-...
-uv run scripts/ingest_docs.py        # cache HTML pages
-uv run scripts/extract_endpoints.py  # LLM extraction → api-model.json
-uv run scripts/generate_commands.py  # regenerate commands/*.py
-```
-
-Generated files are marked with `# Auto-generated from api-model.json` and are
-safe to overwrite. Files without that header are treated as hand-edited and
-left alone.
-
-## Releasing
-
-Releases are published to PyPI by GitHub Actions on a tag push:
-
-```bash
-# Bump version in pyproject.toml, update CHANGELOG.md, commit
-git tag v0.1.1 && git push --tags
-```
-
-PyPI publishing uses Trusted Publishing (OIDC) — no API token is stored.
-Configure once at https://pypi.org/manage/project/qualys-cli/settings/publishing/.
-
 ## License
 
-[MIT](LICENSE)
+MIT

{qualys_cli-0.1.1 → qualys_cli-0.1.3}/pyproject.toml

@@ -4,8 +4,8 @@ build-backend = "hatchling.build"
 
 [project]
 name = "qualys-cli"
-version = "0.1.1"
-description = "Command-line interface for the Qualys REST APIs (VM, PC, PM, ETM, WAS, TC, CA, CS, CSAM, Sub, Asset, User)."
+version = "0.1.3"
+description = "Unified command-line interface for the Qualys Cloud Platform REST APIs (VM, PC, PM, ETM, WAS, TotalCloud, Cloud Agent, Container Security, CSAM, Subscription, Asset, and User management)."
 readme = { file = "README.md", content-type = "text/markdown" }
 license = { file = "LICENSE" }
 requires-python = ">=3.11"
@@ -65,10 +65,7 @@ codegen = [
 qualys-cli = "qualys_cli.cli:main"
 
 [project.urls]
-Homepage      = "https://github.com/qualys/qualys-cli"
-Documentation = "https://github.com/qualys/qualys-cli#readme"
-Issues        = "https://github.com/qualys/qualys-cli/issues"
-Changelog     = "https://github.com/qualys/qualys-cli/blob/main/CHANGELOG.md"
+Homepage = "https://www.qualys.com"
 
 [dependency-groups]
 dev = [
@@ -84,9 +81,6 @@ dev = [
 [tool.hatch.build.targets.wheel]
 packages = ["src/qualys_cli"]
 
-[tool.hatch.build.targets.wheel.shared-data]
-"docs/usage.html" = "share/qualys-cli/docs/usage.html"
-
 [tool.hatch.build.targets.sdist]
 include = [
     "src/qualys_cli",
@@ -95,7 +89,6 @@ include = [
     "CHANGELOG.md",
     "LICENSE",
     "pyproject.toml",
-    "docs/usage.html",
 ]
 exclude = [
     ".cache",