From 4747c5ce5f5731fd73f80702dd02f01548ddec94 Mon Sep 17 00:00:00 2001 From: Calvin Remsburg Date: Sat, 14 Mar 2026 05:24:13 -0500 Subject: [PATCH] docs: fix inaccurate CLI docs, update architecture, improve README UX - remove non-existent `profiles get` and `topics get` from CLI reference and runtime-security feature doc (SDK has no get method) - update architecture overview: runtime config mgmt in domain table, expanded Management description in module table - add Runtime Security card to docs index.md - improve README: docs link as blockquote callout, scan logs in table - bump version to 1.14.2 Closes #177 Co-Authored-By: Claude Opus 4.6 --- README.md | 18 +++++++----------- docs/architecture/overview.md | 4 ++-- docs/features/runtime-security.md | 2 -- docs/index.md | 8 ++++++++ docs/reference/cli-commands.md | 4 ---- package.json | 2 +- 6 files changed, 18 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index fb21cb0..83594e9 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,9 @@ [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) [![Node 20+](https://img.shields.io/badge/node-%3E%3D20-brightgreen.svg)](https://nodejs.org/) -**CLI and library for Palo Alto Prisma AIRS — guardrail refinement, AI red teaming, model security scanning, and profile audits.** +**Full operational coverage over Palo Alto Prisma AIRS AI security — guardrail refinement, runtime scanning, AI red teaming, model security, and profile audits.** + +> **[Read the full documentation](https://cdot65.github.io/daystrom/)** — installation, configuration, architecture, CLI reference, and examples. ## Install @@ -21,24 +23,18 @@ cp .env.example .env # add your API keys daystrom generate # interactive guardrail generation ``` -## Documentation - -Full docs — installation, configuration, architecture, CLI reference, examples, and more: - -**[cdot65.github.io/daystrom](https://cdot65.github.io/daystrom/)** - ## Commands | Command | Description | |---------|-------------| | `generate` | LLM-driven guardrail generation with iterative refinement | | `resume` | Resume a paused or failed generation run | -| `report` | View results for a saved run | +| `report` | View results for a saved run (terminal, JSON, HTML) | | `list` | List all saved runs | -| `runtime` | Prompt scanning + AIRS config management (profiles, topics, API keys, apps) | +| `runtime` | Prompt scanning + config management (profiles, topics, API keys, apps, scan logs) | | `audit` | Multi-topic profile evaluation with conflict detection | -| `redteam` | Red team scanning — targets, prompt sets, scans, reports | -| `model-security` | ML model supply chain security — groups, rules, scans | +| `redteam` | Adversarial scanning — targets, prompt sets, scans, reports | +| `model-security` | ML model supply chain security — groups, rules, scans, labels | ## License diff --git a/docs/architecture/overview.md b/docs/architecture/overview.md index 1677beb..f427905 100644 --- a/docs/architecture/overview.md +++ b/docs/architecture/overview.md @@ -44,7 +44,7 @@ graph LR | Domain | CLI Commands | Service Layer | |--------|-------------|---------------| | **Guardrail Generation** | `generate`, `resume`, `report`, `list` | Core loop + LLM + Scanner + Management | -| **Runtime Security** | `runtime scan`, `runtime bulk-scan` | `SdkRuntimeService` (sync + async scan) | +| **Runtime Security** | `runtime scan`, `runtime bulk-scan`, `runtime profiles`, `runtime topics`, `runtime api-keys`, `runtime customer-apps`, `runtime deployment-profiles`, `runtime dlp-profiles`, `runtime scan-logs` | `SdkRuntimeService` (sync + async scan) + `SdkManagementService` (config CRUD) | | **AI Red Teaming** | `redteam scan`, `redteam targets`, `redteam prompt-sets`, `redteam prompts`, `redteam properties` | `SdkRedTeamService` + `SdkPromptSetService` | | **Model Security** | `model-security groups`, `model-security rules`, `model-security scans`, `model-security labels` | `SdkModelSecurityService` | | **Profile Audits** | `audit` | Audit runner + Scanner + LLM | @@ -96,7 +96,7 @@ graph TD | **`config/`** | Zod schema with coercion and defaults; cascade loader merges CLI flags, env vars, config file, and defaults | | **`core/`** | AsyncGenerator loop that yields typed events, metric computation (TPR/TNR/F1), and AIRS constraint validation | | **`llm/`** | Factory for 6 LangChain providers, structured output with Zod schemas, and prompt templates for all 4 LLM calls | -| **`airs/`** | Scanner (sync scan + batched concurrency), Runtime (sync + async bulk scan with polling), Management (topic CRUD + profile linking), Red Team (scan CRUD/polling/reports), Prompt Sets (custom prompt set management), Model Security (groups/rules/scans) | +| **`airs/`** | Scanner (sync scan + batched concurrency), Runtime (sync + async bulk scan with polling), Management (topic CRUD, profile CRUD, API keys, customer apps, deployment/DLP profiles, scan logs), Red Team (scan CRUD/polling/reports), Prompt Sets (custom prompt set management), Model Security (groups/rules/scans) | | **`memory/`** | File-based learning store, LLM-driven extraction after each run, and budget-aware injection into future prompts | | **`persistence/`** | `JsonFileStore` serializes `RunState` to `~/.daystrom/runs/` for pause/resume support | | **`audit/`** | Profile-level multi-topic evaluation — generates tests per topic, computes per-topic and composite metrics, detects cross-topic conflicts | diff --git a/docs/features/runtime-security.md b/docs/features/runtime-security.md index 1db5152..5233e54 100644 --- a/docs/features/runtime-security.md +++ b/docs/features/runtime-security.md @@ -161,7 +161,6 @@ Daystrom exposes full CRUD over AIRS runtime configuration resources via `daystr ```bash daystrom runtime profiles list -daystrom runtime profiles get daystrom runtime profiles create --config profile.json daystrom runtime profiles update --config profile.json daystrom runtime profiles delete @@ -172,7 +171,6 @@ daystrom runtime profiles delete --force --updated-by user@example.c ```bash daystrom runtime topics list -daystrom runtime topics get daystrom runtime topics create --config topic.json daystrom runtime topics update --config topic.json daystrom runtime topics delete diff --git a/docs/index.md b/docs/index.md index af6f659..7205c99 100644 --- a/docs/index.md +++ b/docs/index.md @@ -59,6 +59,14 @@ Daystrom is a CLI tool that provides full operational coverage over **Palo Alto Optionally carry forward test prompts across iterations with dedup, catching regressions that fresh tests might miss. +- :material-shield-search:{ .lg .middle } **Runtime Security** + + --- + + Scan prompts against live security profiles and manage AIRS configuration — profiles, topics, API keys, customer apps, and scan logs via `daystrom runtime`. + + [:octicons-arrow-right-24: Runtime Security](features/runtime-security.md) + - :material-sword:{ .lg .middle } **AI Red Teaming** --- diff --git a/docs/reference/cli-commands.md b/docs/reference/cli-commands.md index e488548..986ad74 100644 --- a/docs/reference/cli-commands.md +++ b/docs/reference/cli-commands.md @@ -287,7 +287,6 @@ Security profile CRUD. ```bash daystrom runtime profiles list -daystrom runtime profiles get daystrom runtime profiles create --config daystrom runtime profiles update --config daystrom runtime profiles delete @@ -297,7 +296,6 @@ daystrom runtime profiles delete --force --updated-by | Subcommand | Flags | |------------|-------| | `list` | — | -| `get ` | — | | `create` | `--config ` (required) | | `update ` | `--config ` (required) | | `delete ` | `--force`, `--updated-by ` | @@ -308,7 +306,6 @@ Custom topic CRUD. ```bash daystrom runtime topics list -daystrom runtime topics get daystrom runtime topics create --config daystrom runtime topics update --config daystrom runtime topics delete @@ -318,7 +315,6 @@ daystrom runtime topics delete --force --updated-by | Subcommand | Flags | |------------|-------| | `list` | — | -| `get ` | — | | `create` | `--config ` (required) | | `update ` | `--config ` (required) | | `delete ` | `--force`, `--updated-by ` | diff --git a/package.json b/package.json index b2cf067..a72229d 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@cdot65/daystrom", "packageManager": "pnpm@10.6.5", - "version": "1.14.1", + "version": "1.14.2", "description": "CLI and library for Palo Alto Prisma AIRS — guardrail refinement, AI red teaming, model security scanning, profile audits", "type": "module", "main": "dist/index.js",