Skip to content

Commit 5cc66f4

Browse files
Your Nameclaude
andcommitted
Polish README and add SECURITY.md for launch readiness
- Remove Claude Code plugin promo (spam on Reddit/HN) - Fix Python badge URL (was pointing to nonexistent pypi.org/project/ai-trace) - Rewrite Why section with real pain story (3AM bad trade postmortem) - Add SECURITY.md for consistency with other stack repos Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent eb3c99a commit 5cc66f4

2 files changed

Lines changed: 42 additions & 14 deletions

File tree

README.md

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![PyPI version](https://badge.fury.io/py/ai-decision-tracer.svg)](https://pypi.org/project/ai-decision-tracer/)
44
[![Downloads](https://img.shields.io/pypi/dm/ai-decision-tracer)](https://pypi.org/project/ai-decision-tracer/)
55
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
6-
[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://pypi.org/project/ai-trace/)
6+
[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/)
77

88
**Zero-dependency local AI agent decision tracer.**
99

@@ -14,11 +14,6 @@ Part of the **AI Agent Infrastructure Stack**:
1414
- [ai-injection-guard](https://github.com/LuciferForge/prompt-shield) — prompt injection scanner
1515
- **ai-trace** — local decision tracer ← you are here
1616

17-
**Claude Code users** — install the whole stack in one command:
18-
```
19-
/plugin marketplace add LuciferForge/lucifer-skills
20-
```
21-
2217
---
2318

2419
## Install
@@ -53,17 +48,13 @@ tracer.save_markdown() # → traces/trading_agent_20240301_143022.md
5348

5449
---
5550

56-
## Why
51+
## Why this exists
5752

58-
When you run an autonomous AI agent in production — trading bot, document processor, customer service agent — you need to know *why* it made every decision.
53+
My trading bot made a bad trade at 3AM. Lost money. I had logs — thousands of lines of `print()` spam — but I couldn't answer the basic question: **what did the agent see at the moment it decided to enter that position?**
5954

60-
Not just the final output. The full chain:
61-
- What data it saw
62-
- What it computed
63-
- What it decided
64-
- What happened next
55+
Was it a bad signal? A stale data feed? A prompt injection that slipped past the scanner? Without a structured decision trace, postmortems are guesswork.
6556

66-
`ai-trace` gives you that. Locally. No external service.
57+
`ai-trace` records every step an AI agent takes — what it saw, what it decided, why, and how long it took. JSONL auto-save (survives crashes), Markdown reports (human-readable), and a CLI for quick inspection. No cloud. No external service. Everything stays local.
6758

6859
---
6960

SECURITY.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Security Policy
2+
3+
## What this library protects against
4+
5+
`ai-decision-tracer` was built for production autonomous AI systems where
6+
understanding agent behavior is critical for security and compliance.
7+
8+
### 1. Crash-safe trace persistence
9+
All steps are auto-saved to JSONL as they complete. If your agent crashes
10+
mid-execution, you still have a full trace up to the failure point.
11+
Uses atomic writes (temp file + rename) to prevent partial/corrupt output.
12+
13+
### 2. No data exfiltration
14+
All trace data stays local. No network calls. No telemetry. No cloud sync.
15+
Your agent decisions, inputs, and outputs never leave your machine.
16+
17+
### 3. Safe error capture
18+
Stack traces from exceptions are captured in the trace file for postmortems,
19+
but the library never logs raw prompts or full model responses unless you
20+
explicitly pass them to `step.log()`. You control what gets recorded.
21+
22+
### 4. No runtime dependencies
23+
Zero third-party dependencies — nothing to supply-chain attack.
24+
Pure Python stdlib only.
25+
26+
## Supported Versions
27+
28+
| Version | Supported |
29+
|---------|-----------|
30+
| 0.1.x ||
31+
32+
## Reporting a Vulnerability
33+
34+
Please report security vulnerabilities via GitHub Issues (mark as "security").
35+
Do NOT include sensitive data (API keys, prompts) in public issues.
36+
37+
Expected response time: 48 hours.

0 commit comments

Comments
 (0)