{"id":28274009,"url":"https://github.com/anubhavitis/peeksy","last_synced_at":"2025-08-16T22:37:55.767Z","repository":{"id":293054299,"uuid":"982734580","full_name":"anubhavitis/peeksy","owner":"anubhavitis","description":"screenshot name automation tool for macos","archived":false,"fork":false,"pushed_at":"2025-07-09T07:21:45.000Z","size":183,"stargazers_count":10,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-09T08:38:16.798Z","etag":null,"topics":["macos","openapi","rust","screenshots","vision-api"],"latest_commit_sha":null,"homepage":"https://anubhavitis.github.io/peeksy/","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/anubhavitis.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-05-13T10:27:47.000Z","updated_at":"2025-07-09T07:21:38.000Z","dependencies_parsed_at":"2025-05-29T07:42:35.145Z","dependency_job_id":"a434f027-ce7e-4df5-8d49-c79196267af8","html_url":"https://github.com/anubhavitis/peeksy","commit_stats":null,"previous_names":["anubhavitis/screenshot-auto","anubhavitis/peeksy"],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/anubhavitis/peeksy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anubhavitis%2Fpeeksy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anubhavitis%2Fpeeksy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anubhavitis%2Fpeeksy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anubhavitis%2Fpeeksy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/anubhavitis","download_url":"https://codeload.github.com/anubhavitis/peeksy/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anubhavitis%2Fpeeksy/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270781214,"owners_count":24643808,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-16T02:00:11.002Z","response_time":91,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["macos","openapi","rust","screenshots","vision-api"],"created_at":"2025-05-21T01:16:07.000Z","updated_at":"2025-08-16T22:37:55.746Z","avatar_url":"https://github.com/anubhavitis.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\n\u003e ⚠️ **DEPRECATION NOTICE**: This CLI version of Peeksy is now deprecated. All future development has moved to the new GUI application: **[peeksy-app](https://github.com/anubhavitis/peeksy-app)**. \n\u003e \n\u003e The new GUI version offers a much better user experience with visual interface, drag-and-drop functionality, and enhanced features. Please migrate to [peeksy-app](https://github.com/anubhavitis/peeksy-app) for continued updates and support.\n\n\n\u003cimg src=\"assets/peeksy.png\" width=\"150\" height=\"150\" alt=\"Peeksy Logo\" /\u003e\n\n# Peeksy\n\n\nA Rust-based tool that automatically renames screenshots and images using OpenAI's GPT-4 Vision API. The tool analyzes image content and generates descriptive, meaningful filenames following a consistent naming convention.\n\n[View Demo](https://x.com/anubhavitis/status/1922303569639702976)\n\n## Features\n\n- **Automatic Image Analysis**: Uses GPT-4 Vision API for intelligent content recognition\n- **Universal Image Renaming**: Rename any image file, not just screenshots\n- **Bulk Rename Existing Screenshots**: Retroactively rename all your existing screenshots with AI-powered intelligent naming\n- **Auto-Start on Boot**: Automatically starts when your machine restarts via LaunchD integration\n- **Raycast Integration**: Native Raycast app for lightning-fast screenshot management\n- **Intelligent Context Recognition**: Detects screenshots, album covers, artwork, posters, UI elements\n- **Consistent Filename Formatting**: Lowercase, hyphen-separated naming convention\n- **Real-time File Monitoring**: Automatic renaming as you take screenshots\n- **Configurable Naming Rules**: Customizable prompt templates for naming preferences\n\n\n## Requirements\n\n- OpenAI API key with access to GPT-4 Vision API\n\nNote: Peeksy will prompt you to enter OpenApi key them during first run. The values will be automatically saved for future use.\n\n\n## 📦 Installation \u0026 Upgrade\n\nv2.0 launched recently, [read here](https://github.com/anubhavitis/peeksy/releases/tag/v2.0)\n\n⚠️ For existing users, first you'll have to remove the current installation, and get the fresh installation\n```bash\nbrew remove peeksy\nbrew untap anubhavitis/peeksy\nbrew tap anubhavitis/peeksy\nbrew install peeksy\n```\n\nFor new installations:\n\n```bash\nbrew tap anubhavitis/peeksy\nbrew install peeksy\n```\n\n\n\n### Examples\n```bash\n# Start the Peeksy daemon (auto-starts on boot after setup)\npeeksy start\n\n# Check if the daemon is running and get its PID\npeeksy status\n\n# Stop the running daemon\npeeksy stop\n\n# Restart the daemon (useful after configuration changes)\npeeksy restart\n\n# Rename any image file using AI\npeeksy rename-image \"/path/to/your/image.jpg\"\n\n# Bulk rename all existing screenshots in your screenshots folder\npeeksy rename-existing-screenshots\n\n# View your current configuration settings\npeeksy current-config\n\n# View the contents of your prompt template file\npeeksy view-prompt-file\n\n# Update your OpenAI API key\npeeksy update-api-key \"sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\"\n\n# Update the path to your prompt template file\npeeksy update-prompt-file-path \"/path/to/your/custom-prompt.txt\"\n\n# View logs for troubleshooting\npeeksy logs\n\n# Run the daemon directly (usually not needed, use 'start' instead)\npeeksy daemon\n```\n\nNote: The daemon must be running for Peeksy to monitor and rename your screenshots. Use `peeksy status` to verify the daemon is running.\n\n## How to Use\n\nOnce you've completed the installation steps above, Peeksy will automatically monitor your screenshots directory. Here's what happens:\n\n1. **Start the Service**\n   ```bash\n   peeksy start\n   ```\n\n2. **Take Screenshots**\n   - Use your system's screenshot shortcut (⌘⇧3 or ⌘⇧4 on macOS)\n\n3. **Watch the Magic**\n   - Peeksy will detect new screenshots\n   - Analyze the content using GPT-4 Vision\n   - Automatically rename them with descriptive names\n   - Original files are preserved with the new names\n\n4. **Customize (Optional)**\n   ```bash\n   # View your current prompt template\n   peeksy view-prompt-file\n\n   # Update the prompt template\n   peeksy update-prompt-file-path \"path/to/your/custom-prompt.txt\"\n   ```\n\nThat's it! Peeksy will continue running in the background, automatically renaming your screenshots as you take them.\n\n## Commands\n\nPeeksy provides several commands to manage the daemon and configuration:\n\n### Daemon Management\n- `start` - Start the Peeksy daemon\n- `stop` - Stop the running Peeksy daemon\n- `restart` - Restart the Peeksy daemon\n- `status` - Check if the Peeksy daemon is running and get its PID\n\n### Configuration Management\n- `current-config` - Display the current configuration in JSON format\n- `view-prompt-file` - Display the contents of the current prompt file\n- `update-api-key \u003cvalue\u003e` - Update the OpenAI API key\n- `update-prompt-file-path \u003cvalue\u003e` - Update the path to the prompt template file\n\n## Building in your machine\n\n1. Clone the repository:\n   ```bash\n   git clone https://github.com/anubhavitis/peeksy.git\n   cd peeksy\n   ```\n\n2. Build the project:\n   ```bash\n   cargo build --release\n   ```\n\n3. Install the binary:\n   ```bash\n   sudo cp target/release/peeksy /usr/local/bin/\n   ```\n\n4. Start the daemon:\n   ```bash\n   peeksy start\n   ```\n\n5. Verify the installation:\n   ```bash\n   # Check if the daemon is running\n   peeksy status\n\n   # View your current configuration\n   peeksy current-config\n   ```\n\nNote: Make sure you have Rust installed on your system. If not, install it from [rustup.rs](https://rustup.rs/).\n\n# Support \u0026 Queries\n\n\u003e **Note**: This CLI version is deprecated. For new issues and feature requests, please use the new GUI version: **[peeksy-app](https://github.com/anubhavitis/peeksy-app)**\n\nFor legacy CLI support or migration help:\n- [Email](mailto:ss.lfsgd@gmail.com)\n- GitHub Issues: [Create an issue](https://github.com/anubhavitis/peeksy/issues) (CLI-related only)\n\nFor the new GUI version (recommended):\n- **New Repository**: [peeksy-app](https://github.com/anubhavitis/peeksy-app)\n- **Issues \u0026 Features**: [Create an issue in peeksy-app](https://github.com/anubhavitis/peeksy-app/issues)\n\nWe recommend migrating to [peeksy-app](https://github.com/anubhavitis/peeksy-app) for:\n- Better user experience with GUI interface\n- Active development and new features\n- Enhanced functionality and performance\n- Continued support and updates\n   \n# Special Thanks\n\nA heartfelt thank you to:\n\n[navedux](https://naved.xyz) for creating the beautiful Peeksy logo and identity\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanubhavitis%2Fpeeksy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fanubhavitis%2Fpeeksy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanubhavitis%2Fpeeksy/lists"}