skill-project-finisher
v2.0.0
Published
Claude skill that automates project completion with intelligent documentation generation, security checks, and export preparation
Maintainers
Readme
Claude Skill: Project Finisher
Automates project completion with intelligent documentation generation, security checks, and export preparation for Claude AI.
Features
- 🤖 Context-Aware Documentation: Generates README, CHANGELOG, TODO, and ARCHITECTURE docs based on actual project analysis
- 🔒 Security Scanning: Detects hardcoded secrets, API keys, and credentials
- 📦 Smart Export: Prepares timestamped project exports with metadata
- 🎯 Selective Documentation: Only documents critical files, not everything
- 📊 Project Analysis: Automatically detects project type and technologies
- 🔄 Git Integration: Generates CHANGELOG from git history when available
Installation
Quick Install (Recommended)
npx skill-project-finisherThis will automatically install the skill to your Claude skills directory.
Manual Installation
- Clone or download this repository
- Copy the
project-finisherfolder to your Claude skills directory:- macOS:
~/Library/Application Support/Claude/skills/user/ - Linux:
~/.claude/skills/user/ - Windows:
%APPDATA%/Claude/skills/user/
- macOS:
Requirements
- Python 3.x - Required for the automation scripts
- Claude AI - Desktop or web application
Usage
Once installed, use the skill in your Claude conversations by saying:
- "zakończ projekt" (Polish)
- "finish the project"
- "prepare project documentation"
- "document my project"
- "export project files"
Claude will automatically:
- Analyze your project structure
- Detect technologies and dependencies
- Run security checks
- Generate comprehensive documentation
- Prepare an organized export
What Gets Generated
README.md
- Real project description based on code analysis
- Detected requirements and dependencies
- Project-specific installation instructions
- Actual usage examples from your code
- Project structure with module descriptions
CHANGELOG.md
- Git history analysis (if
.gitexists) - Conversation-based summary (if no git)
- Not just a template!
TODO.md
- Extracted TODO/FIXME/HACK comments
- Incomplete features from context
- Missing tests detection
- Improvement suggestions
ARCHITECTURE.md (for projects >15 files)
- Module diagram (Mermaid format)
- Data flow description
- Component descriptions
- Design decisions
Version 2.0 Features
- Context-aware: Uses conversation history
- Intelligent documents: Real analysis, not templates
- Timestamped exports: Never overwrites previous exports
- Better security: Fewer false positives, more patterns
- Selective documentation: Only key files
- Git integration: Real CHANGELOG from commits
- Project type detection: Different templates for different projects
- Performance: Optimized scanning with compiled regex
Scripts
The skill includes these Python scripts in the scripts/ folder:
collect_context.py- Collects project context and conversation summarysecurity_check.py- Advanced security scanning (v2.0)generate_docs.py- Context-aware documentation generation (v2.0)prepare_export.py- Export with timestamps and metadata (v2.0)
Troubleshooting
Skill not appearing in Claude
- Make sure you installed to the correct directory
- Restart Claude completely
- Check that
SKILL.mdexists in the installation directory
Python not found
Install Python 3.x from python.org
Permission errors
On macOS/Linux, you may need to make scripts executable:
chmod +x ~/.claude/skills/user/project-finisher/scripts/*.pyContributing
Contributions are welcome! Please feel free to submit issues or pull requests.
License
MIT License - feel free to use and modify as needed.
Author
emblemo
Support
- GitHub Issues: [Report a bug or request a feature]
- Documentation: [Link to full documentation]
Note: This is a skill for Claude AI. It requires Claude (desktop or web) to function.
