Skip to content

Commit 9b3df11

Browse files
haasonsaasclaude
andcommitted
Update README with v0.2.0 features and improved formatting
- Restructure Features section with better visual hierarchy - Document new CLI commands: init, doctor, explain - Add Embeddings API example and mark as completed in roadmap - Expand CLI documentation with all available commands - Add comprehensive project templates and debugging tools 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent 51d4950 commit 9b3df11

File tree

1 file changed

+45
-4
lines changed

1 file changed

+45
-4
lines changed

README.md

Lines changed: 45 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,23 @@ rules:
154154
chunk_size: 5 # Characters per chunk
155155
```
156156
157+
### Embeddings API
158+
159+
```yaml
160+
version: 1
161+
rules:
162+
- type: llm.openai
163+
when:
164+
endpoint: "/v1/embeddings"
165+
respond:
166+
embeddings:
167+
- embedding: [0.1, 0.2, -0.3, 0.4] # Mock embedding vectors
168+
index: 0
169+
usage:
170+
input_tokens: 5
171+
total_tokens: 5
172+
```
173+
157174
### Limited Usage
158175
159176
```yaml
@@ -169,6 +186,16 @@ rules:
169186
170187
## CLI Commands
171188
189+
### Project Setup
190+
```bash
191+
# Initialize a new project with templates
192+
mocktopus init # Basic template
193+
mocktopus init --template rag # RAG/embeddings testing
194+
mocktopus init --template agents # Multi-step agent workflows
195+
mocktopus init --template multimodal # Image/audio/vision APIs
196+
mocktopus init --template enterprise # Advanced error handling
197+
```
198+
172199
### Start Server
173200
```bash
174201
# Basic usage
@@ -181,12 +208,24 @@ mocktopus serve -s scenario.yaml -p 9000
181208
mocktopus serve -s scenario.yaml -v
182209
```
183210

184-
### Test Scenarios
211+
### Development & Debugging
185212
```bash
186-
# Validate a scenario file
213+
# Validate scenario files with schema checking
187214
mocktopus validate scenario.yaml
188215

189-
# Simulate a request without starting server
216+
# Explain rule matching for debugging
217+
mocktopus explain -s scenario.yaml --prompt "Hello world"
218+
mocktopus explain -s scenario.yaml --model gpt-4 --prompt "help me" -v
219+
220+
# Diagnose configuration issues
221+
mocktopus doctor # General environment check
222+
mocktopus doctor -s scenario.yaml # Diagnose specific scenario
223+
mocktopus doctor --fix # Auto-fix common issues
224+
```
225+
226+
### Testing & Examples
227+
```bash
228+
# Simulate requests without starting server
190229
mocktopus simulate -s scenario.yaml --prompt "Hello"
191230

192231
# Generate example scenarios
@@ -264,8 +303,10 @@ respond:
264303
- [x] Streaming support (SSE)
265304
- [x] Function/tool calling
266305
- [x] Anthropic messages API
306+
- [x] Embeddings API
307+
- [x] Comprehensive CLI tools
308+
- [x] JSON schema validation
267309
- [ ] Recording & replay
268-
- [ ] Embeddings API
269310
- [ ] Assistants API
270311
- [ ] Image generation
271312
- [ ] Semantic similarity matching

0 commit comments

Comments
 (0)