HAL9000
f808abff86
Fix JSON syntax errors in .devcontainer/devcontainer.json (removed
invalid JS-style // comments) and .devcontainer/opencode.json (removed
90+ trailing commas). Apply auto-fixes for end-of-file and trailing
whitespace issues across 100+ files. Fix SIM105 ruff violations in
benchmarks/core_circuit_breaker_bench.py (use contextlib.suppress).
Note: The security fix from issue #7478 (validate_path startswith bypass)
was already delivered to master in commit e18ac5f2. This PR as currently
structured is non-atomic (35 commits across 10+ issues) and needs
significant restructure before merge. This commit only addresses the
CI/pre-commit failures.
ISSUES CLOSED: #7478
99 lines
2.3 KiB
Markdown
99 lines
2.3 KiB
Markdown
# [Example Title - e.g., "Building a Simple Todo CLI App"]
|
|
|
|
## Overview
|
|
[Brief 2-3 sentence description of what this example demonstrates and why it's useful. Focus on the practical value and what the user will learn.]
|
|
|
|
## Prerequisites
|
|
- CleverAgents installed (`pip install cleveragents`)
|
|
- Python 3.12 or higher
|
|
- [Any additional requirements specific to this example]
|
|
|
|
## What You'll Build
|
|
[Detailed description of the end result - what will the user have when they complete this example? Include key features and capabilities.]
|
|
|
|
## Step-by-Step Walkthrough
|
|
|
|
### Step 1: [Initialize the Project]
|
|
```bash
|
|
$ agents [command with arguments]
|
|
```
|
|
|
|
**Expected Output:**
|
|
```
|
|
[Actual output from the UAT test run]
|
|
```
|
|
|
|
**What's Happening:**
|
|
[Explanation of what CleverAgents is doing at this step - help the user understand the system's behavior]
|
|
|
|
### Step 2: [Define the Core Functionality]
|
|
```bash
|
|
$ agents [next command]
|
|
```
|
|
|
|
**Expected Output:**
|
|
```
|
|
[Actual output]
|
|
```
|
|
|
|
**What's Happening:**
|
|
[Explanation of this step's purpose and what's being created]
|
|
|
|
### Step 3: [Add Features/Test/Deploy]
|
|
```bash
|
|
$ agents [command]
|
|
```
|
|
|
|
**Expected Output:**
|
|
```
|
|
[Output showing success]
|
|
```
|
|
|
|
**What's Happening:**
|
|
[Explanation of final steps]
|
|
|
|
## Testing Your Creation
|
|
|
|
### Running the Application
|
|
```bash
|
|
$ [command to run the created app]
|
|
```
|
|
|
|
**Example Usage:**
|
|
```
|
|
[Show the app in action with sample inputs/outputs]
|
|
```
|
|
|
|
## Complete Interaction Log
|
|
<details>
|
|
<summary>Click to see the full CleverAgents session log</summary>
|
|
|
|
```
|
|
[Timestamp] Starting CleverAgents session...
|
|
[Timestamp] User: agents [initial command]
|
|
[Timestamp] CleverAgents: [response]
|
|
[... complete timestamped interaction log ...]
|
|
[Timestamp] Session completed successfully.
|
|
```
|
|
</details>
|
|
|
|
## Key Takeaways
|
|
- [Important concept or pattern demonstrated]
|
|
- [Best practice illustrated]
|
|
- [Feature of CleverAgents highlighted]
|
|
- [Common use case addressed]
|
|
|
|
## Try It Yourself
|
|
Now that you've seen how to [what was built], try these variations:
|
|
- [Suggested modification 1]
|
|
- [Suggested modification 2]
|
|
- [Challenge: Advanced variation]
|
|
|
|
## Related Examples
|
|
- [Link to similar example if exists]
|
|
- [Link to more advanced example if exists]
|
|
|
|
---
|
|
*This example was automatically generated and verified by the CleverAgents UAT system.*
|
|
*Feature area: [area] | Test cycle: [N] | Generated: [timestamp]*
|