add cargo release config and docs

Author: alexylon

.cargo-release-cheatsheet.md

@@ -0,0 +1,83 @@
+# Release Cheat Sheet
+
+## Before Release
+```bash
+git status                    # All changes committed?
+cargo test                    # Tests pass?
+cargo fmt                     # Code formatted?
+```
+
+## Dry Run (Always Do This First!)
+```bash
+cargo release --dry-run       # Preview what will happen
+```
+
+## Execute Release
+```bash
+# Patch release (0.1.17 → 0.1.18)
+cargo release patch
+
+# Minor release (0.1.17 → 0.2.0)
+cargo release minor
+
+# Major release (0.1.17 → 1.0.0)
+cargo release major
+
+# Or just run (auto-detects)
+cargo release
+```
+
+## What Happens Automatically
+1. ✅ Bumps version in `Cargo.toml`
+2. ✅ Runs tests: `cargo test`
+3. ✅ Checks formatting: `cargo fmt --check`
+4. ✅ Updates `CHANGELOG.md`
+5. ✅ Runs: `cargo publish -p sofos`
+6. ✅ Creates commit: `Release vX.Y.Z`
+7. ✅ Creates tag: `vX.Y.Z`
+8. ✅ Pushes to remote
+
+## Skip Publishing
+```bash
+cargo release --no-publish    # Don't publish to crates.io
+cargo release --no-push       # Don't push to Git
+```
+
+## After Release
+Check on GitHub:
+- New release in "Releases" tab
+- New tag in "Tags" tab
+- New commit on main branch
+
+Check on crates.io:
+- https://crates.io/crates/sofos
+
+## Troubleshooting
+
+| Issue | Fix |
+|-------|-----|
+| "Uncommitted changes" | `git add . && git commit -m "msg"` |
+| "No commits since last release" | Make some commits first |
+| "crates.io already has this version" | Bump the version |
+| "Failed to push" | Check push access and branch |
+| "Failed to publish" | Run `cargo login` |
+
+## Advanced Options
+
+```bash
+cargo release --help          # Full help
+cargo release --dry-run       # Preview without changes
+cargo release --allow-dirty   # Skip git status check
+cargo release --sign-commit   # GPG sign commits
+cargo release --sign-tag      # GPG sign tags
+```
+
+## Config Files
+
+- **release.toml** - Release automation configuration
+- **RELEASE.md** - Full documentation
+- **CHANGELOG.md** - Release notes (auto-updated)
+
+---
+
+**Quick tip:** Always run `cargo release --dry-run` first to preview!

CHANGELOG.md

@@ -0,0 +1,220 @@
+# Changelog
+
+All notable changes to Sofos are documented in this file.
+
+## [Unreleased]
+
+## [0.1.17] - 2026-01-08
+
+### Changed
+- Renamed `mcpServers` to `mcp-servers` in config
+- Reduced `max_context_tokens` for cost optimization
+
+### Fixed
+- Image detection failing when messages contain apostrophes/contractions
+
+## [0.1.16] - 2026-01-04
+
+### Added
+- MCP (Model Context Protocol) server integration for extending tool capabilities
+- Cost optimizations: caching, token-efficient tools, and output truncation
+
+### Changed
+- Updated `reqwest` crate
+- Display all loaded MCP servers on app startup
+- Updated `is_blocked` error messages
+
+### Fixed
+- MCP image handling: use separate image blocks instead of embedded base64
+- Web search tool result block filtering for Anthropic
+
+## [0.1.15] - 2025-12-31
+
+### Added
+- Cyrillic character support in history
+
+### Changed
+- Reorganized files and logic into cleaner structure
+
+## [0.1.14] - 2025-12-24
+
+### Added
+- Markdown formatting and code syntax highlighting
+
+## [0.1.13] - 2025-12-23
+
+### Added
+- Cursor shape changes depending on edit mode
+- Improved ripgrep detection and empty file type handling
+
+### Changed
+- Handle image paths with spaces
+- Removed blinking cursor after command execution
+- Updated readline library and prompt symbols
+- Included image tool in safe mode
+
+### Fixed
+- Abort API calls on ESC for immediate REPL interruption
+- Auto-continue OpenAI reasoning-only responses
+
+## [0.1.12] - 2025-12-22
+
+### Added
+- Local and web image vision support
+- Context token limiting
+- Actionable hints to all error messages
+- Enhanced confirmation dialogs with icons, colors, and safe defaults
+- Security level distinction for error messages
+
+### Changed
+- Standardized message formatting with two-line hint structure
+- Improved RawModeGuard usage for panic safety
+- Network resilience improvements and crash point elimination
+- Added thread join timeout to prevent UI hangs
+- Retry jitter and Unix signal detection
+
+### Fixed
+- Session-scoped permissions
+
+## [0.1.11] - 2025-12-21
+
+### Added
+- Global config support in `~/.sofos/config.toml`
+- Read permission system with glob patterns and tilde expansion
+- Homebrew install option
+
+### Changed
+- Block tilde paths in bash to enforce workspace sandboxing
+- Type safety improvements and centralized config
+- Updated project structure documentation
+
+### Security
+- Allowed `2>&1` for stderr/stdout combining in bash
+
+## [0.1.10] - 2025-12-21
+
+### Added
+- Network resilience and crash point elimination
+
+## [0.1.9] - 2025-12-22
+
+### Added
+- Prompt caching for Claude API
+- Caching to read_file_tool
+- System prompt support for OpenAI
+
+### Changed
+- Refactored prompt caching system
+
+## [0.1.8] - 2025-12-18
+
+### Added
+- 3-tier permission system for bash execution (Allow/Deny/Ask)
+- Config migration from JSON to TOML
+- Refactored type safety and centralized config
+
+## [0.1.7] - 2025-12-18
+
+### Changed
+- Migrated config from JSON to TOML format
+
+## [0.1.6] - 2025-12-18
+
+### Security
+- Implemented 3-tier permission system for bashexec: Allow, Deny, Ask
+
+## [0.1.5] - 2025-12-15
+
+### Added
+- Prompt caching for Claude
+- System prompt handling for OpenAI
+
+## [0.1.4] - 2025-12-14
+
+### Added
+- Installation from crates.io
+- Documentation links
+- Crates.io version badge
+- Links and resources section to README
+
+## [0.1.3] - 2025-12-14
+
+### Changed
+- Keywords and metadata updates
+
+### Added
+- Support for multiple installation methods (Homebrew, crates.io)
+
+## [0.1.2] - 2025-12-10
+
+### Added
+- OpenAI API support
+- OpenAI web search tool
+- Support for all GPT-5 models with Responses API
+- OpenAI reasoning model handling
+- Safe mode for restricted capabilities
+- Tab-based command selection (replaced rustyline with reedline)
+
+### Changed
+- Enabled Morph integration for OpenAI models
+- Model pricing fixes
+
+### Fixed
+- Conversation workflow improvements
+
+## [0.1.1] - 2025-12-09
+
+### Added
+- Morph Fast Apply integration
+- Ripgrep code search integration
+- Bash executor with safety checks
+- File operations: delete, move, copy
+- Programmatic confirmation for destructive operations
+- Thinking animation
+- Visual diff display
+- Session save/restore functionality
+- Claude web-search tool integration
+- Syntax highlighting
+- Team and personal instructions support
+- Git operations restrictions (read-only)
+- Reject reasons for restricted bash commands
+- Bash output size limiting (50MB)
+- Conversation history limiting
+- File size checks (10MB limit)
+- Extended thinking capability
+- Iterative tool execution loop (max 200 iterations)
+- Retry logic with session preservation for network failures
+- Token usage and estimated cost display
+- ESC key to interrupt API calls
+- Separate REPL logic refactoring
+
+### Changed
+- Replaced recursion with iterative loop for tool execution
+- Updated dependency versions
+- Improved README documentation
+- Updated default Claude model
+
+### Fixed
+- Symlink escape prevention
+- File size limit enforcement
+- Conversation workflow
+- Warning fixes
+
+## [0.1.0] - 2025-12-04
+
+### Added
+- Initial release
+- Claude AI integration for coding assistance
+- Interactive REPL with session persistence
+- File system operations (read, write, list, delete, move, copy)
+- Sandboxed bash command execution
+- Code search via ripgrep
+- Tool calling with iterative execution
+- Conversation history management
+- Custom instructions support (.sofosrc)
+- API request building and response handling
+- Error handling with user-friendly messages
+
+---
+
+**Versioning:** This project follows [Semantic Versioning](https://semver.org/).

README.md

@@ -26,6 +26,7 @@ Tested on macOS but should work on Linux and Windows as well.
 - [Security](#security)
 - [Configuration](#configuration)
 - [Development](#development)
+- [Release](#release)
 - [Troubleshooting](#troubleshooting)
 - [Morph Integration](#morph-integration)
 - [License](#license)
@@ -333,6 +334,33 @@ src/
 
 See `.sofosrc` for detailed conventions.
 
+## Release
+
+This project uses **cargo-release** for automated versioning and publishing.
+
+**Quick commands:**
+
+```bash
+# Preview the release (dry run)
+cargo release --dry-run
+
+# Execute the release (full workflow)
+cargo release
+
+# Release specific version
+cargo release [major|minor|patch]
+```
+
+The release workflow automatically:
+1. Bumps version in `Cargo.toml`
+2. Runs tests and formatting checks
+3. Updates `CHANGELOG.md`
+4. Creates release commit and Git tag (`v0.1.18`)
+5. Pushes to remote repository
+6. Publishes to crates.io
+
+**For detailed instructions** (including setup, troubleshooting, and advanced options), see [RELEASE.md](RELEASE.md).
+
 ## Troubleshooting
 
 - **API errors:** Check connection and API key