Skip to content

Commit 9a221e0

Browse files
author
ConnorWhelan11
committed
README fix
1 parent 67db41e commit 9a221e0

File tree

1 file changed

+26
-15
lines changed

1 file changed

+26
-15
lines changed

README.md

Lines changed: 26 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -50,22 +50,26 @@
5050
<span style="opacity:0.55;">&nbsp;&nbsp;&middot;&nbsp;&nbsp;</span>
5151
<a href="docs/src/getting-started/quick-start-python.md">Python</a>
5252
<span style="opacity:0.55;">&nbsp;&nbsp;&middot;&nbsp;&nbsp;</span>
53+
<a href="packages/clawdstrike-openclaw/docs/getting-started.md">OpenClaw</a>
54+
<span style="opacity:0.55;">&nbsp;&nbsp;&middot;&nbsp;&nbsp;</span>
5355
<a href="examples">Examples</a>
5456
</p>
5557

5658
---
5759

58-
## What is Clawdstrike?
60+
## Overview
61+
62+
> **Alpha Software** — This project is under active development and not yet published. Packages are not available on npm or crates.io. A full beta launch is planned for the coming week. APIs may change. Star/watch the repo to follow progress.
5963
60-
Runtime security enforcement for AI agents. Composable guards, cryptographic receipts, and policy-driven access control at the tool boundary.
64+
Clawdstrike provides runtime security enforcement for agents, designed for developers building EDR solutions and security infrastructure on top of OpenClaw.
6165

62-
**Guards** — Block sensitive paths, control network egress, detect secrets, validate patches, restrict tools, catch jailbreaks
66+
<img src=".github/assets/sigils/boundary-light.svg#gh-light-mode-only" width="16" height="16" alt="" style="vertical-align:-3px;margin-right:6px;" /> <img src=".github/assets/sigils/boundary-dark.svg#gh-dark-mode-only" width="16" height="16" alt="" style="vertical-align:-3px;margin-right:6px;" />**Guards** — Block sensitive paths, control network egress, detect secrets, validate patches, restrict tools, catch jailbreaks
6367

64-
**Receipts** — Ed25519-signed attestations proving what was decided, under which policy, with what evidence
68+
<img src=".github/assets/sigils/policy-light.svg#gh-light-mode-only" width="16" height="16" alt="" style="vertical-align:-3px;margin-right:6px;" /> <img src=".github/assets/sigils/policy-dark.svg#gh-dark-mode-only" width="16" height="16" alt="" style="vertical-align:-3px;margin-right:6px;" />**Receipts** — Ed25519-signed attestations proving what was decided, under which policy, with what evidence
6569

66-
**Multi-language** — Rust, TypeScript, Python, WebAssembly
70+
<img src=".github/assets/sigils/seal-light.svg#gh-light-mode-only" width="16" height="16" alt="" style="vertical-align:-3px;margin-right:6px;" /> <img src=".github/assets/sigils/seal-dark.svg#gh-dark-mode-only" width="16" height="16" alt="" style="vertical-align:-3px;margin-right:6px;" />**Multi-language** — Rust, TypeScript, Python, WebAssembly
6771

68-
**Multi-framework** — OpenClaw, Vercel AI, LangChain, Claude Code, and more
72+
<img src=".github/assets/sigils/ruleset-light.svg#gh-light-mode-only" width="16" height="16" alt="" style="vertical-align:-3px;margin-right:6px;" /> <img src=".github/assets/sigils/ruleset-dark.svg#gh-dark-mode-only" width="16" height="16" alt="" style="vertical-align:-3px;margin-right:6px;" />**Multi-framework** — OpenClaw, Vercel AI, LangChain, Claude Code, and more
6973

7074
## Quick Start
7175

@@ -84,13 +88,20 @@ TypeScript does not ship a full policy engine; use the Rust CLI/daemon for evalu
8488

8589
```typescript
8690
import { createHushCliEngine } from "@clawdstrike/hush-cli-engine";
87-
import { BaseToolInterceptor, createSecurityContext } from "@clawdstrike/adapter-core";
91+
import {
92+
BaseToolInterceptor,
93+
createSecurityContext,
94+
} from "@clawdstrike/adapter-core";
8895

8996
const engine = createHushCliEngine({ policyRef: "default" });
9097
const interceptor = new BaseToolInterceptor(engine, { blockOnViolation: true });
9198
const ctx = createSecurityContext({ sessionId: "session-123" });
9299

93-
const preflight = await interceptor.beforeExecute("bash", { cmd: "echo hello" }, ctx);
100+
const preflight = await interceptor.beforeExecute(
101+
"bash",
102+
{ cmd: "echo hello" },
103+
ctx
104+
);
94105
if (!preflight.proceed) throw new Error("Blocked by policy");
95106
```
96107

@@ -100,14 +111,14 @@ See `packages/clawdstrike-openclaw/docs/getting-started.md`.
100111

101112
## Highlights
102113

103-
| Feature | Description |
104-
|---------|-------------|
105-
| **7 Built-in Guards** | Path, egress, secrets, patches, tools, prompt injection, jailbreak |
114+
| Feature | Description |
115+
| ------------------------------- | ----------------------------------------------------------------------------- |
116+
| **7 Built-in Guards** | Path, egress, secrets, patches, tools, prompt injection, jailbreak |
106117
| **4-Layer Jailbreak Detection** | Heuristic + statistical + ML + optional LLM-as-judge with session aggregation |
107-
| **Output Sanitization** | Redact secrets, PII, internal data from LLM output with streaming support |
108-
| **Prompt Watermarking** | Embed signed provenance markers for attribution and forensics |
109-
| **Fail-Closed Design** | Invalid policies reject at load time; errors deny access |
110-
| **Signed Receipts** | Tamper-evident audit trail with Ed25519 signatures |
118+
| **Output Sanitization** | Redact secrets, PII, internal data from LLM output with streaming support |
119+
| **Prompt Watermarking** | Embed signed provenance markers for attribution and forensics |
120+
| **Fail-Closed Design** | Invalid policies reject at load time; errors deny access |
121+
| **Signed Receipts** | Tamper-evident audit trail with Ed25519 signatures |
111122

112123
## Documentation
113124

0 commit comments

Comments
 (0)