Skip to content

Commit dceac0c

Browse files
dgerogclaude
andcommitted
Update docs: remove Shadow AI branding, fix command names, add missing flags
- Rename "Shadow AI Discovery" to "AI Discovery" throughout - Fix command name mismatches: connectors add→create, remove→delete, api-keys revoke→delete, members remove→delete, campaigns break→terminate - Add missing --assessment and --finding flags to logs docs - Add missing --output/-o flag to findings docs - Add report subcommand docs for projects, experiments, assessments, orgs - Fix experiments.md: remove nonexistent `hb experiments logs`, add report - Fix assessments.md: wrong command form for report Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 548a32a commit dceac0c

File tree

11 files changed

+69
-37
lines changed

11 files changed

+69
-37
lines changed

docs/docs/concepts/campaigns.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ hb campaigns --json
1818

1919
```bash
2020
# Stop with confirmation prompt
21-
hb campaigns break
21+
hb campaigns terminate
2222

2323
# Skip confirmation
24-
hb campaigns break --force
24+
hb campaigns terminate --force
2525
```
2626

2727
## ASCAM Activities

docs/docs/concepts/security-posture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ hb posture --org
4343
Org posture aggregates three dimensions:
4444

4545
- **Agent Security** -- posture across all security-tested projects
46-
- **Shadow AI** -- risk posture of discovered AI inventory assets
46+
- **AI Discovery** -- risk posture of discovered AI inventory assets
4747
- **Quality** -- behavioral quality across all tested agents
4848

4949
## Include Coverage Breakdown

docs/docs/getting-started/quick-start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ hb connect -e ./bot-config.json --repo ./agent-code --serve
4747
hb connect -e ./bot-config.json --context "Authenticated as Alice"
4848
```
4949

50-
### Scan Cloud Platform (Shadow AI Discovery)
50+
### Scan Cloud Platform (AI Discovery)
5151

5252
```bash
5353
# Browser-based scan, no connector needed

docs/docs/integrations/discovery.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Shadow AI Discovery
1+
# AI Discovery
22

33
Discover and assess AI services across your cloud environment. The discovery pipeline scans your tenant client-side, sends results to the Humanbound platform for security evaluation (38 evidence signals, 15 SAI threat classes), and produces an assessed inventory with posture scoring and model lifecycle tracking.
44

@@ -28,18 +28,18 @@ The discovery report includes:
2828
- **In Development** -- ML projects and staged resources
2929
- **Resource Topology** -- Interactive Mermaid diagram showing connections between agents, endpoints, models, and channels
3030
- **Security Evaluations** -- Per-service threat analysis with SAI threat classes, risk scores, and remediation guidance
31-
- **Posture Estimate** -- Organisation-level shadow AI posture score
31+
- **Posture Estimate** -- Organisation-level AI discovery posture score
3232

3333
## Cloud Connectors
3434

3535
Register cloud connectors for persistent discovery. Connectors store encrypted credentials and enable re-discovery (scheduled or on-demand).
3636

3737
```bash
3838
# Register a Microsoft connector
39-
$ hb connectors add --tenant-id <id> --client-id <id> --client-secret
39+
$ hb connectors create --tenant-id <id> --client-id <id> --client-secret
4040

4141
# Register with explicit vendor and display name
42-
$ hb connectors add --vendor microsoft --tenant-id <id> --client-id <id> --name "Production"
42+
$ hb connectors create --vendor microsoft --tenant-id <id> --client-id <id> --name "Production"
4343

4444
# List connectors
4545
$ hb connectors
@@ -55,7 +55,7 @@ $ hb connectors update <connector-id> --client-secret
5555
$ hb connectors update <connector-id> --name "New Name" --status disabled
5656

5757
# Remove a connector
58-
$ hb connectors remove <connector-id>
58+
$ hb connectors delete <connector-id>
5959
```
6060

6161
## AI Inventory
@@ -83,7 +83,7 @@ $ hb inventory update <asset-id> --sanctioned --owner "security@company.com"
8383
$ hb inventory update <asset-id> --department "Engineering" --business-purpose "Customer support"
8484
$ hb inventory update <asset-id> --has-policy --has-risk-assessment
8585

86-
# View shadow AI posture (with optional HTML report)
86+
# View AI discovery posture (with optional HTML report)
8787
$ hb inventory posture
8888
$ hb inventory posture --report
8989

docs/docs/management/api-keys.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,10 @@ hb api-keys update <id> --inactive
3838

3939
```bash
4040
# Revoke with confirmation
41-
hb api-keys revoke <id>
41+
hb api-keys delete <id>
4242

4343
# Skip confirmation
44-
hb api-keys revoke <id> --force
44+
hb api-keys delete <id> --force
4545
```
4646

4747
## Scopes

docs/docs/management/experiments.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,12 @@ hb experiments wait <id> --timeout 60
4242
## View Experiment Logs
4343

4444
```bash
45-
# View all logs
46-
hb experiments logs <id>
45+
# View logs for a specific experiment
46+
hb logs <id>
4747

48-
# Filter by result
49-
hb experiments logs <id> --result fail
50-
hb experiments logs <id> --result pass
48+
# Filter by verdict
49+
hb logs <id> --verdict fail
50+
hb logs <id> --verdict pass
5151

5252
# Export branded HTML report
5353
hb logs <id> --format html -o report.html
@@ -63,6 +63,19 @@ hb logs --days 7 --format json -o week.json
6363
hb logs --from 2026-01-01 --until 2026-02-01 --format html -o jan.html
6464
```
6565

66+
## Generate Experiment Report
67+
68+
```bash
69+
# Generate HTML report (opens in browser by default)
70+
hb experiments report <id>
71+
72+
# Save to file
73+
hb experiments report <id> -o report.html
74+
75+
# Save without opening browser
76+
hb experiments report <id> -o report.html --no-open
77+
```
78+
6679
## Terminate Running Experiment
6780

6881
```bash

docs/docs/management/members.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ hb members invite user@example.com --role admin
2222

2323
```bash
2424
# Remove with confirmation
25-
hb members remove <id>
25+
hb members delete <id>
2626

2727
# Skip confirmation
28-
hb members remove <id> --force
28+
hb members delete <id> --force
2929
```
3030

3131
## Access Levels

docs/docs/management/projects.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,5 +47,18 @@ hb projects delete <id>
4747
hb projects delete <id> --force
4848
```
4949

50+
## Generate Project Report
51+
52+
```bash
53+
# Generate HTML report (opens in browser by default)
54+
hb projects report
55+
56+
# Save to file
57+
hb projects report -o report.html
58+
59+
# Save without opening browser
60+
hb projects report -o report.html --no-open
61+
```
62+
5063
!!! warning "Warning"
5164
Deleting a project will also delete all associated experiments, logs, and findings. This action cannot be undone.

docs/docs/reference/commands.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ Complete reference of all available commands, organized by category.
4242
| `hb experiments show <id>` | Show detailed experiment information |
4343
| `hb experiments status [id] [--all]` | Check experiment status (single, watch, or all-experiments dashboard) |
4444
| `hb experiments wait <id>` | Block until experiment completes (CI/CD) |
45-
| `hb experiments logs <id>` | View conversation logs and verdicts |
4645
| `hb experiments terminate <id>` | Stop running experiment |
4746
| `hb experiments delete <id>` | Delete experiment and logs |
4847
| `hb status [--all]` | Check status of latest experiment or all experiments (alias) |
@@ -51,44 +50,44 @@ Complete reference of all available commands, organized by category.
5150

5251
| Command | Description |
5352
|---|---|
54-
| `hb logs` | View logs from latest experiment or project-wide with scope flags (--last, --category, --days, --from, --until) |
53+
| `hb logs` | View logs from latest experiment or project-wide with scope flags (--last, --category, --days, --from, --until, --assessment \<id\>, --finding \<id\>) |
5554
| `hb posture` | View security posture score and grade |
5655
| `hb posture --trends` | View historical posture timeline |
5756
| `hb coverage` | View test coverage summary and gaps |
58-
| `hb findings` | List persistent vulnerability findings |
57+
| `hb findings` | List persistent vulnerability findings (--page, --size, -o \<file\>) |
5958
| `hb findings update <id>` | Update finding status or severity |
6059
| `hb findings assign <id>` | Assign finding to a team member |
6160
| `hb assessments` | List past security assessments |
6261
| `hb assessments show <id>` | View assessment detail (posture before/after, drift, test count) |
63-
| `hb assessments report <id>` | Generate assessment HTML report with full test logs |
64-
| `hb projects report` | Generate project HTML security report |
65-
| `hb orgs report` | Generate organisation-wide HTML report |
66-
| `hb experiments report <id>` | Generate experiment HTML report with methodology context |
62+
| `hb assessments report <id>` | Generate assessment HTML report with full test logs (-o, --no-open) |
63+
| `hb projects report` | Generate project HTML security report (-o, --no-open) |
64+
| `hb orgs report` | Generate organisation-wide HTML report (-o, --no-open) |
65+
| `hb experiments report <id>` | Generate experiment HTML report with methodology context (-o, --no-open) |
6766

6867
## Security
6968

7069
| Command | Description |
7170
|---|---|
7271
| `hb guardrails` | Export learned security rules and patterns |
7372
| `hb campaigns` | View current ASCAM campaign plan |
74-
| `hb campaigns break` | Stop running campaign |
73+
| `hb campaigns terminate` | Stop running campaign |
7574
| `hb logs upload` | Upload production conversations for evaluation |
7675
| `hb monitor` | Start, pause, or resume continuous monitoring |
7776

78-
## Shadow AI Discovery
77+
## AI Discovery
7978

8079
| Command | Description |
8180
|---|---|
82-
| `hb connect --vendor <name>` | Scan cloud platform for shadow AI services |
81+
| `hb connect --vendor <name>` | Scan cloud platform for AI services |
8382
| `hb connectors` | List registered cloud connectors |
84-
| `hb connectors add` | Register new cloud connector with credentials |
83+
| `hb connectors create` | Register new cloud connector with credentials |
8584
| `hb connectors test <id>` | Test connector connectivity |
8685
| `hb connectors update <id>` | Update connector name, credentials, or status |
87-
| `hb connectors remove <id>` | Delete a connector |
86+
| `hb connectors delete <id>` | Delete a connector |
8887
| `hb inventory` | List discovered AI assets with filters |
8988
| `hb inventory view <id>` | View detailed asset information |
9089
| `hb inventory update <id>` | Update governance fields (owner, sanctioned, policy) |
91-
| `hb inventory posture` | View shadow AI posture score |
90+
| `hb inventory posture` | View AI discovery posture score |
9291
| `hb inventory onboard <id>` | Create security testing project from asset |
9392
| `hb inventory archive <id>` | Archive an inventory asset |
9493

@@ -116,10 +115,10 @@ Complete reference of all available commands, organized by category.
116115
| `hb api-keys list` | List API keys for programmatic access |
117116
| `hb api-keys create` | Create new API key (shown once) |
118117
| `hb api-keys update <id>` | Update key name or activation status |
119-
| `hb api-keys revoke <id>` | Revoke and delete API key |
118+
| `hb api-keys delete <id>` | Revoke and delete API key |
120119
| `hb members list` | List organisation members |
121120
| `hb members invite` | Invite new member to organisation |
122-
| `hb members remove <id>` | Remove member from organisation |
121+
| `hb members delete <id>` | Remove member from organisation |
123122

124123
## Help & Shell
125124

docs/docs/testing/assessments.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,15 @@ hb assessments show <assessment-id>
1717
## Generate Assessment Report
1818

1919
```bash
20-
hb report --assessment <assessment-id>
20+
# Generate HTML report (opens in browser by default)
21+
hb assessments report <assessment-id>
22+
23+
# Save to file
24+
hb assessments report <assessment-id> -o report.html
25+
26+
# Save without opening browser
27+
hb assessments report <assessment-id> -o report.html --no-open
2128
```
2229

2330
!!! info "Note"
24-
Assessments are created automatically by ASCAM activities. Use `hb assessments list` to see history and `hb report --assessment` to generate a detailed report for any past assessment.
31+
Assessments are created automatically by ASCAM activities. Use `hb assessments list` to see history and `hb assessments report <id>` to generate a detailed report for any past assessment.

0 commit comments

Comments
 (0)