{"id":21948433,"url":"https://github.com/devuri/zipit","last_synced_at":"2026-02-20T18:04:21.349Z","repository":{"id":260639224,"uuid":"881941772","full_name":"devuri/zipit","owner":"devuri","description":"ZipIt is a simple, flexible PHP CLI tool for creating zip archives, providing features like progress bars and recursive file archiving.","archived":false,"fork":false,"pushed_at":"2025-02-15T16:15:16.000Z","size":2348,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-19T04:55:01.641Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/devuri.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-11-01T14:41:39.000Z","updated_at":"2025-02-15T16:15:08.000Z","dependencies_parsed_at":"2024-11-01T15:07:52.212Z","dependency_job_id":"dacf11a0-0313-4fee-ba49-3051e325100c","html_url":"https://github.com/devuri/zipit","commit_stats":null,"previous_names":["devuri/zipit"],"tags_count":6,"template":false,"template_full_name":"devuri/dot-access","purl":"pkg:github/devuri/zipit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devuri%2Fzipit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devuri%2Fzipit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devuri%2Fzipit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devuri%2Fzipit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devuri","download_url":"https://codeload.github.com/devuri/zipit/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devuri%2Fzipit/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29659754,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-20T16:33:43.953Z","status":"ssl_error","status_checked_at":"2026-02-20T16:33:43.598Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":[],"created_at":"2024-11-29T05:14:23.672Z","updated_at":"2026-02-20T18:04:16.339Z","avatar_url":"https://github.com/devuri.png","language":"PHP","readme":"# ZipIt\n\n**ZipIt** is a simple, flexible PHP CLI tool for creating zip archives, providing features like progress bars, customizable output locations, and recursive file archiving. It now includes a `copy` command to duplicate files instead of zipping them.\n\n## Features\n\n- **Standalone Executable**: ZipIt is now a fully compiled executable file, which can be stored in your project (e.g., `bin/zipit`).\n- **Configurable**: Define the base directory, files to include, and exclusions in a `.zipit-conf.php` file.\n- **Customizable Output**: Optionally specify the output file name and path in the configuration file.\n- **Recursive Archiving**: Automatically includes directories and their contents.\n- **Styled Output**: Uses color-coded messages for warnings, errors, and success feedback.\n- **Progress Bar**: Visual progress for long-running operations.\n- **Custom Config Path**: Option to specify a custom configuration file path.\n- **Copy Command**: Use `bin/zipit copy` to copy files instead of zipping them.\n\n## Installation\n\nDownload the `zipit` executable and place it in your project directory, for example:\n\n```bash\nmv zipit bin/zipit\nchmod +x bin/zipit\n```\n\n## Configuration\n\nCreate a `.zipit-conf.php` file in your project root directory. This file should return an array with the following configuration keys:\n\n```php\n\u003c?php\n\nreturn [\n    'baseDir' =\u003e __DIR__, // The base directory where files are located\n    'files' =\u003e [          // List of files and directories to include\n        'file1.txt',\n        'directory1',\n        'file2.txt',\n    ],\n    'exclude' =\u003e [        // List of files and directories to exclude\n        'directory1/exclude-this.txt',\n        'file-to-exclude.txt',\n    ],\n    'outputDir' =\u003e __DIR__ . '/build', // Optional: Custom output directory path\n    'outputFile' =\u003e 'project-archive.zip', // Optional: Custom output file name\n];\n```\n\n### Configuration Details\n\n- **baseDir**: The root directory for all files to be zipped. Paths in `files` and `exclude` are relative to this directory.\n- **files**: Array of files and directories to include in the zip archive.\n- **exclude**: Array of files and directories to exclude. Paths are also relative to `baseDir`.\n- **outputDir**: (Optional) Specify a custom directory for the output. If not provided, the timestamp will be used.\n- **outputFile**: (Optional) Specify a custom name for the output zip file. If not provided, the file name `project-archive-{timestamp}` will be used.\n\n## Usage\n\nAfter setting up the `.zipit-conf.php` file, use the `zipit` command with optional the path to the configuration file, it will look for config file in the current directory.\n\n### Running ZipIt\n\nRun **ZipIt** from your project’s root directory:\n\n```bash\nbin/zipit /path/to/.zipit-conf.php\n```\n\n### Example\n\nSuppose you have the following directory structure:\n\n```\n/my-project\n  |-- file1.txt\n  |-- file2.txt\n  |-- /directory1\n      |-- file3.txt\n      |-- exclude-this.txt\n  |-- .zipit-conf.php\n```\n\nIn `.zipit-conf.php`:\n\n```php\n\u003c?php\n\nreturn [\n    'baseDir' =\u003e __DIR__,\n    'files' =\u003e [\n        'file1.txt',\n        'file2.txt',\n        'directory1',\n    ],\n    'exclude' =\u003e [\n        'directory1/exclude-this.txt',\n    ],\n    'outputFile' =\u003e __DIR__ . '/project-archive.zip', // Optional: Custom output file name\n];\n```\n\nRunning `bin/zipit /path/to/.zipit-conf.php` will create `project-archive.zip` in the project root if `outputFile` is set. Otherwise, it will create an archive with `file1.txt`, `file2.txt`, and `directory1/file3.txt`, while excluding `directory1/exclude-this.txt`.\n\n## Output\n\n- **Styled Messages**: Errors, warnings, and notes are shown in color for easy readability.\n- **Progress Bar**: Tracks the zipping process to keep you informed.\n\n## Requirements\n\n- PHP 8.1 or higher\n\n## License\n\nThis project is licensed under the MIT License. See the LICENSE file for details.\n\nEnjoy easy archiving with **ZipIt**!\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevuri%2Fzipit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevuri%2Fzipit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevuri%2Fzipit/lists"}