Skip to content

PaperCLI v2.0.2 - Code Architecture & Documentation Improvements

Choose a tag to compare

@SXKDZ SXKDZ released this 15 Aug 06:23
· 18 commits to main since this release

This release delivers important bug fixes and comprehensive documentation updates, ensuring accurate user guidance and improved code reliability across the application.

πŸ› Critical Bug Fixes

πŸ–±οΈ Multiselect UI Correction

β€’ Fixed Toast Message: Corrected multiselect mode toast notification showing incorrect ESC key binding
β€’ Accurate Instructions: Now correctly displays F11 as the exit key for multiselect mode
β€’ User Experience: Eliminates confusion about keyboard shortcuts during multiselect operations

πŸ“¦ Import Dependencies

β€’ Missing Import Fix: Added missing time import in collection dialog preventing potential runtime errors
β€’ Code Reliability: Ensures all time-dependent functionality in collection management works correctly
β€’ Stability Enhancement: Prevents import errors during collection operations

πŸ“š Comprehensive Documentation Overhaul

πŸ“– README.md Major Update

β€’ Installation Instructions: Updated source installation command to use correct ng.papercli module path
β€’ Keyboard Shortcuts: Updated all keyboard shortcut documentation to match actual implementation
β€’ Command Reference: Added comprehensive subcommand documentation for all available commands
β€’ Configuration Variables: Complete environment variable documentation including new options
β€’ Export Formats: Updated export format documentation with IEEE references and all available options
β€’ Roadmap Cleanup: Removed outdated roadmap items that are no longer relevant

⌨️ Accurate Keyboard Documentation

β€’ ESC vs Ctrl+C: Corrected documentation showing ESC clears input (now correctly shows Ctrl+C)
β€’ Function Keys: Verified all F1-F12 key bindings match actual implementation
β€’ Chat Interface: Updated chat interface shortcuts to reflect current functionality
β€’ Selection Mode: Corrected multiselect exit key documentation (F11, not ESC)

βš™οΈ Enhanced Configuration Documentation

β€’ Environment Variables: Added missing OPENAI_MAX_TOKENS, OPENAI_TEMPERATURE configuration options
β€’ Theme Support: Documented PAPERCLI_THEME environment variable
β€’ OneDrive Settings: Added PAPERCLI_REMOTE_PATH and PAPERCLI_AUTO_SYNC documentation
β€’ PDF Settings: Enhanced PAPERCLI_PDF_PAGES documentation

πŸ“‹ Complete Command Documentation

β€’ Add Commands: Detailed subcommands for all paper addition methods (arxiv, dblp, pdf, etc.)
β€’ Edit Commands: Comprehensive edit subcommands with field-specific editing options
β€’ Filter Commands: Complete filter subcommands for all search criteria
β€’ Export Commands: All available export formats with specific command syntax
β€’ Config Commands: Enhanced configuration command documentation with all available options

πŸ”§ Technical Improvements

πŸ“ Code Organization

β€’ Import Management: Proper import organization in collection dialog module
β€’ Dependencies: Ensured all required modules are correctly imported
β€’ Code Reliability: Enhanced error prevention through proper dependency management

πŸ“ Documentation Accuracy

β€’ Implementation Sync: Documentation now accurately reflects actual codebase implementation
β€’ Feature Coverage: All features and commands properly documented with correct syntax
β€’ User Guidance: Clear, accurate instructions for all application functionality
β€’ Module Paths: Corrected installation and running instructions for new architecture

πŸ“¦ Installation

# Via pipx (recommended)
pipx install git+https://github.com/SXKDZ/papercli.git@v2.0.2

# Via pip
pip install git+https://github.com/SXKDZ/papercli.git@v2.0.2

# Update existing installation
pipx reinstall git+https://github.com/SXKDZ/papercli.git@v2.0.2

πŸ“ˆ Development Impact

This maintenance release delivers:
β€’ Critical UI Fix: Corrected multiselect mode user guidance
β€’ Import Reliability: Fixed missing dependencies preventing runtime errors
β€’ Documentation Accuracy: Major README.md overhaul ensuring all documentation matches implementation
β€’ User Experience: Improved user guidance through accurate keyboard shortcut and command documentation
β€’ Configuration Coverage: Complete environment variable documentation for all available options
β€’ Installation Instructions: Updated for new ng/ architecture with correct module paths


Full Changelog: v2.0.1...v2.0.2