Skip to content

3C0D/copy-new

Repository files navigation

✍️ Writing Tools

A powerful AI-powered writing assistant that integrates seamlessly with your workflow through system tray access and global hotkeys.

🚀 Quick Start

Run from Source (Fastest for development)

python Windows_and_Linux/scripts/dev_script.py

Build and Test (Recommended for testing)

python Windows_and_Linux/scripts/build_dev.py

Debug Mode (When things go wrong)

python Windows_and_Linux/scripts/build_dev.py --console

✨ Features

  • 🤖 Multiple AI Providers: OpenAI, Gemini, Ollama (auto-install), Anthropic, Mistral
  • ⚡ Global Hotkeys: Quick access from anywhere
  • 🎨 Smart Theming: Auto dark/light mode detection
  • 📋 System Tray: Unobtrusive background operation
  • 🔧 Flexible Configuration: Per-provider settings and customization
  • 🌍 Cross-Platform: Windows and Linux support

🛠️ Development

Prerequisites

  • Python 3.8+
  • Virtual environment (automatically created)
  • Windows 10/11 or Linux

Development Workflow

  1. Quick Testing: python Windows_and_Linux/scripts/dev_script.py
  2. Build Testing: python Windows_and_Linux/scripts/build_dev.py
  3. Debug Issues: python Windows_and_Linux/scripts/build_dev.py --console
  4. Production Build: python Windows_and_Linux/scripts/build_final.py

VS Code Integration

All scripts work perfectly with Code Runner:

  1. Open any script file
  2. Press Ctrl+F5
  3. Script runs with proper environment setup

🐛 Troubleshooting

Systray Icon Missing

# Debug startup issues
python Windows_and_Linux/scripts/startup_debug.py

# For boot-time issues
python Windows_and_Linux/scripts/install_startup_debug.py

Build Failures

# Update dependencies first
python Windows_and_Linux/scripts/update_deps.py

# Then try console mode for detailed output
python Windows_and_Linux/scripts/build_dev.py --console

Provider Issues

  • Check API keys in Settings
  • Verify internet connection
  • Try different provider in Settings window

📚 Documentation

🎯 Usage

  1. Launch the application using any of the methods above
  2. Configure your AI provider in the system tray settings
    • For Ollama: Click "Install Ollama" for automatic setup, then install models via command line (ollama pull llama3.2)
  3. Set up hotkeys for quick access
  4. Select text anywhere and use your hotkey
  5. Choose from predefined prompts or create custom ones
  6. Get AI-powered writing assistance instantly

🔧 Architecture

This version features a complete architectural overhaul with:

  • Multi-mode system (dev/build-dev/build-final)
  • Robust settings management with automatic migration
  • Enhanced debugging tools for development
  • Improved build system with console mode support
  • Better error handling and logging

🤝 Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Use the development scripts for testing
  4. Submit a pull request

📄 License

[Add your license information here]

🙏 Acknowledgments

Based on the original Writing Tools project, enhanced with modern development practices and improved reliability.


Need help? Check the troubleshooting section or review the documentation for detailed guides.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages