|
1 | 1 | # 🧠 Cloudflare Agents |
2 | 2 |
|
3 | | -🚧 **Work in Progress** 🚧 |
| 3 | + |
4 | 4 |
|
5 | | -A collection of examples and tools for building AI agents that run on Cloudflare Workers. The goal is to make it easy to build stateful, long-running agents that can communicate in real-time and run at the edge. |
| 5 | +_This project is in active development. Join us in shaping the future of intelligent agents._ |
6 | 6 |
|
7 | | -## Current Status |
| 7 | +Welcome to a new paradigm in AI development. Cloudflare Agents provides the foundation for building intelligent, stateful agents that persist, think, and evolve at the edge of the network. |
8 | 8 |
|
9 | | -This is an early-stage project. We're currently building out: |
| 9 | +## Vision |
10 | 10 |
|
11 | | -- Example implementations |
12 | | -- Documentation and guides |
13 | | -- A core agent framework |
| 11 | +We're creating a framework where AI agents can: |
14 | 12 |
|
15 | | -Stay tuned for updates! |
| 13 | +- Maintain persistent state and memory |
| 14 | +- Engage in real-time communication |
| 15 | +- Process and learn from interactions |
| 16 | +- Operate autonomously at global scale |
| 17 | +- Hibernate when idle, awaken when needed |
| 18 | + |
| 19 | +## Project Status |
| 20 | + |
| 21 | +This project is actively evolving. Current focus areas: |
| 22 | + |
| 23 | +### Ready for Use |
| 24 | + |
| 25 | +- Core agent framework with state management |
| 26 | +- Real-time WebSocket communication |
| 27 | +- HTTP endpoints and routing |
| 28 | +- React integration hooks |
| 29 | +- Basic AI chat capabilities |
| 30 | + |
| 31 | +### In Development |
| 32 | + |
| 33 | +- Advanced memory systems |
| 34 | +- WebRTC for audio/video |
| 35 | +- Email integration |
| 36 | +- Evaluation framework |
| 37 | +- Enhanced observability |
| 38 | +- Self-hosting guide |
16 | 39 |
|
17 | 40 | ## Getting Started |
18 | 41 |
|
19 | | -Check out the `/examples` directory for current implementations. Each example has its own README with setup instructions. |
| 42 | +### Quick Start |
| 43 | + |
| 44 | +```bash |
| 45 | +# Create a new project |
| 46 | +npm create cloudflare@latest -- --template agents |
| 47 | + |
| 48 | +# Or add to existing project |
| 49 | +npm install @cloudflare/agents |
| 50 | +``` |
| 51 | + |
| 52 | +## Documentation |
| 53 | + |
| 54 | +For comprehensive documentation and guides: |
| 55 | + |
| 56 | +- [Core Framework](packages/agents/README.md) |
| 57 | +- [The Anthropic Patterns for building effective agents](guides/anthropic-patterns/README.md) |
| 58 | +- [Human in the Loop](guides/humans-in-the-loop/README.md) |
| 59 | +- [Playground](examples/playground/README.md) |
| 60 | + |
| 61 | +## Contributing |
| 62 | + |
| 63 | +We welcome contributions! Whether it's: |
| 64 | + |
| 65 | +- New examples |
| 66 | +- Documentation improvements |
| 67 | +- Bug fixes |
| 68 | +- Feature suggestions |
20 | 69 |
|
21 | 70 | ## License |
22 | 71 |
|
23 | | -MIT License - feel free to use and adapt as needed. |
| 72 | +MIT License - Build something meaningful. |
| 73 | + |
| 74 | +--- |
0 commit comments