Skip to content

Commit 7d54b53

Browse files
committed
docs: comprehensive documentation updates for v0.1.0 release
- Add PyPI, tests, and coverage badges to README - Update installation section to reflect PyPI availability - Replace AWS Strands examples with framework-agnostic examples - Document auto-setup features (.chatrc and ~/.prompts/) - Update dependencies section with correct requirements - Completely rewrite docs/INSTALL.md for PyPI-first installation - Add platform-specific installation notes - Create comprehensive docs/TROUBLESHOOTING.md - Add troubleshooting quick links to README - Update support section with GitHub links
1 parent d62edc5 commit 7d54b53

3 files changed

Lines changed: 859 additions & 221 deletions

File tree

README.md

Lines changed: 101 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# Basic Agent Chat Loop
22

3+
[![PyPI version](https://img.shields.io/pypi/v/basic-agent-chat-loop.svg)](https://pypi.org/project/basic-agent-chat-loop/)
34
[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
5+
[![Tests](https://github.com/Open-Agent-Tools/Basic-Agent-Chat-Loop/actions/workflows/ci.yml/badge.svg)](https://github.com/Open-Agent-Tools/Basic-Agent-Chat-Loop/actions/workflows/ci.yml)
6+
[![codecov](https://codecov.io/gh/Open-Agent-Tools/Basic-Agent-Chat-Loop/branch/main/graph/badge.svg)](https://codecov.io/gh/Open-Agent-Tools/Basic-Agent-Chat-Loop)
47
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
58

69
A feature-rich, interactive CLI for AI agents with token tracking, prompt templates, agent aliases, and extensive configuration options.
@@ -21,101 +24,126 @@ A feature-rich, interactive CLI for AI agents with token tracking, prompt templa
2124

2225
## Installation
2326

24-
### PyPI Install (Coming Soon)
27+
### Quick Install (Recommended)
2528

2629
```bash
2730
pip install basic-agent-chat-loop
2831
```
2932

30-
### From Source
33+
That's it! The package will automatically create:
34+
- `~/.chatrc` - Configuration file with recommended defaults
35+
- `~/.prompts/` - Sample prompt templates (on first use)
3136

32-
**Recommended (editable install):**
37+
### Platform-Specific Options
3338

39+
**Windows (for command history support):**
3440
```bash
35-
git clone <repo-url> Basic-Agent-Chat-Loop
36-
cd Basic-Agent-Chat-Loop
37-
pip install -e .
41+
pip install basic-agent-chat-loop[windows]
3842
```
3943

40-
**Windows users (for command history support):**
41-
44+
**AWS Bedrock integration:**
4245
```bash
43-
pip install -e ".[windows]"
46+
pip install basic-agent-chat-loop[bedrock]
4447
```
4548

46-
**Development install:**
49+
### From Source
50+
51+
For development or the latest features:
4752

4853
```bash
54+
git clone https://github.com/Open-Agent-Tools/Basic-Agent-Chat-Loop.git
55+
cd Basic-Agent-Chat-Loop
4956
pip install -e ".[dev]"
5057
```
5158

52-
See [docs/INSTALL.md](docs/INSTALL.md) for detailed installation instructions.
59+
See [docs/INSTALL.md](docs/INSTALL.md) for detailed installation instructions and troubleshooting.
5360

5461
## Quick Start
5562

5663
### Basic Usage
5764

5865
```bash
5966
# Run with agent path
60-
chat_loop AWS_Strands/Product_Pete/agent.py
67+
chat_loop path/to/your/agent.py
6168

62-
# Run with alias (after saving)
63-
chat_loop pete
69+
# Or use an alias (after saving)
70+
chat_loop myagent
6471
```
6572

6673
### Agent Aliases
6774

6875
Save frequently used agents for quick access:
6976

7077
```bash
71-
# Save aliases
72-
chat_loop --save-alias pete AWS_Strands/Product_Pete/agent.py
73-
chat_loop --save-alias clara AWS_Strands/Complex_Coding_Clara/agent.py
78+
# Save an agent as an alias
79+
chat_loop --save-alias myagent path/to/agent.py
7480

75-
# Use aliases from anywhere
76-
chat_loop pete
77-
chat_loop clara
81+
# Use the alias from anywhere
82+
chat_loop myagent
7883

79-
# List all aliases
84+
# List all saved aliases
8085
chat_loop --list-aliases
8186

8287
# Remove an alias
83-
chat_loop --remove-alias pete
88+
chat_loop --remove-alias myagent
89+
```
90+
91+
**Example with real agents:**
92+
```bash
93+
# Save your agents
94+
chat_loop --save-alias pete ~/agents/product_manager/agent.py
95+
chat_loop --save-alias dev ~/agents/senior_developer/agent.py
96+
97+
# Use them from anywhere
98+
cd ~/projects/my-app
99+
chat_loop dev # Get coding help
100+
chat_loop pete # Get product feedback
84101
```
85102

86103
Aliases are stored in `~/.chat_aliases` and work from any directory.
87104

88105
### Prompt Templates
89106

90-
Create reusable prompt templates:
107+
The package automatically creates sample templates in `~/.prompts/` on first use:
108+
- `explain.md` - Explain code in detail
109+
- `review.md` - Code review with best practices
110+
- `debug.md` - Help debugging issues
111+
- `optimize.md` - Performance optimization suggestions
112+
- `test.md` - Generate test cases
113+
- `document.md` - Add documentation
91114

115+
**Use templates in chat:**
92116
```bash
93-
# Create template directory
94-
mkdir -p ~/.prompts
95-
96-
# Create a code review template
97-
cat > ~/.prompts/review.md <<'EOF'
98-
# Code review
99-
Please review the following code for:
100-
- Best practices and design patterns
101-
- Potential bugs or edge cases
117+
chat_loop myagent
118+
You: /review src/app.py
119+
You: /explain utils.py
120+
You: /test my_function
121+
```
122+
123+
**Create custom templates:**
124+
```bash
125+
# Create your own template
126+
cat > ~/.prompts/security.md <<'EOF'
127+
# Security Review
128+
129+
Please review this code for security vulnerabilities:
130+
102131
{input}
132+
133+
Focus on:
134+
- Input validation
135+
- Authentication/authorization
136+
- Data sanitization
137+
- Common security patterns
103138
EOF
104139

105-
# Use template in chat
106-
chat_loop pete
107-
You: /review my_code.py
140+
# Use it in chat
141+
You: /security auth.py
108142
```
109143

110144
## Configuration
111145

112-
Create a configuration file at `~/.chatrc`:
113-
114-
```bash
115-
cp .chatrc.example ~/.chatrc
116-
```
117-
118-
Example configuration:
146+
A configuration file (`~/.chatrc`) is automatically created on first use with recommended defaults. You can customize it to your preferences:
119147

120148
```yaml
121149
features:
@@ -212,20 +240,25 @@ chat.run()
212240

213241
### Core Dependencies
214242

215-
- `anthropic-bedrock>=0.8.0` - AWS Bedrock integration
243+
- **Python 3.8+**
216244
- `pyyaml>=6.0.1` - Configuration file parsing
245+
- `rich>=13.7.0` - Enhanced terminal rendering
246+
- `python-dotenv>=1.0.0` - Environment variable management
217247

218-
### Optional (Recommended)
248+
### Optional Dependencies
219249

220-
- `rich>=13.7.0` - Enhanced terminal rendering
221-
- `readline` (built-in on Unix) - Command history
222-
- `pyreadline3` (Windows only) - Command history support
250+
- `pyreadline3>=3.4.1` - Command history on Windows (install with `[windows]`)
251+
- `anthropic-bedrock>=0.8.0` - AWS Bedrock integration (install with `[bedrock]`)
252+
253+
### Built-in Features
254+
255+
- `readline` (built-in on Unix) - Command history on macOS/Linux
223256

224257
## Platform Support
225258

226259
- ✅ **macOS** - Full support with native readline
227260
- ✅ **Linux** - Full support with native readline
228-
- ✅ **Windows** - Full support (install via `install.bat` or `install.py`)
261+
- ✅ **Windows** - Full support with `pip install basic-agent-chat-loop[windows]`
229262

230263
## Architecture
231264

@@ -287,19 +320,33 @@ MIT License - see LICENSE file for details.
287320

288321
## Changelog
289322

290-
### v1.0.0 (2025-10-08)
323+
See [CHANGELOG.md](CHANGELOG.md) for detailed version history.
324+
325+
### Latest Release: v0.1.0 (2025-10-09)
291326

292-
-Initial release
327+
Initial public release with:
293328
- 🏷️ Agent alias system
294-
- 📝 Prompt templates
329+
- 📝 Prompt templates with auto-setup
295330
- 💰 Token tracking and cost estimation
296-
- ⚙️ YAML configuration with per-agent overrides
331+
- ⚙️ YAML configuration with auto-setup
297332
- 📊 Status bar and session summaries
298333
- 🎨 Rich markdown rendering
299334
- 🔄 Automatic error recovery
300335
- 📜 Persistent command history
301-
- 🌐 Cross-platform installers (macOS, Linux, Windows)
336+
- ✅ 61% test coverage (158 tests)
337+
338+
## Troubleshooting
339+
340+
See [docs/TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md) for common issues and solutions.
341+
342+
**Quick fixes:**
343+
- **Package not found**: Run `pip install --upgrade basic-agent-chat-loop`
344+
- **Command not found**: Ensure pip's bin directory is in your PATH
345+
- **Import errors**: Try reinstalling with `pip install --force-reinstall basic-agent-chat-loop`
302346

303347
## Support
304348

305-
For issues, questions, or contributions, please visit the [repository](https://github.com/yourusername/Basic-Agent-Chat-Loop).
349+
- 🐛 **Bug Reports**: [GitHub Issues](https://github.com/Open-Agent-Tools/Basic-Agent-Chat-Loop/issues)
350+
- 💡 **Feature Requests**: [GitHub Issues](https://github.com/Open-Agent-Tools/Basic-Agent-Chat-Loop/issues)
351+
- 📖 **Documentation**: [docs/](docs/)
352+
- 💬 **Discussions**: [GitHub Discussions](https://github.com/Open-Agent-Tools/Basic-Agent-Chat-Loop/discussions)

0 commit comments

Comments
 (0)