{"id":26566288,"url":"https://github.com/code-soup/ziploy-cli","last_synced_at":"2026-05-04T14:36:06.619Z","repository":{"id":280962830,"uuid":"941845657","full_name":"code-soup/ziploy-cli","owner":"code-soup","description":"Ziploy CLI is a :zap: lightning fast command‑line script that automates deployment via the ziploy‑github‑action and can also be run locally.","archived":false,"fork":false,"pushed_at":"2025-03-14T13:43:08.000Z","size":29136,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-22T18:20:28.974Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.ziploy.com","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/code-soup.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}},"created_at":"2025-03-03T06:32:55.000Z","updated_at":"2025-03-14T07:31:10.000Z","dependencies_parsed_at":"2025-03-06T09:35:58.669Z","dependency_job_id":null,"html_url":"https://github.com/code-soup/ziploy-cli","commit_stats":null,"previous_names":["code-soup/ziploy-cli"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/code-soup/ziploy-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-soup%2Fziploy-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-soup%2Fziploy-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-soup%2Fziploy-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-soup%2Fziploy-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/code-soup","download_url":"https://codeload.github.com/code-soup/ziploy-cli/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-soup%2Fziploy-cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32612136,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-04T10:08:07.713Z","status":"ssl_error","status_checked_at":"2026-05-04T10:08:02.005Z","response_time":58,"last_error":"SSL_read: 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":"2025-03-22T18:20:07.485Z","updated_at":"2026-05-04T14:36:06.584Z","avatar_url":"https://github.com/code-soup.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ziploy CLI\n\n![GitHub release (latest by date)](https://img.shields.io/github/v/release/code-soup/ziploy-cli?style=flat-square)\n![License](https://img.shields.io/github/license/code-soup/ziploy-cli?style=flat-square)\n\nZiploy CLI is a :zap: lightning fast command‑line script that automates deployment via the [ziploy‑github‑action](https://github.com/code-soup/ziploy-github-action) and can also be run locally. This tool packages your project while excluding files specified in a `.ziployignore` file and then deploys it to a target WordPress website.\n\n**Important:** To successfully receive and apply your deployment, the target WordPress site must have the [Ziploy WordPress Plugin](https://www.ziploy.com) installed. This plugin is required whether you run deployments from GitHub Actions or directly from your local machine.\n\n## Installation\n\n-   Download script\n-   add `.ziployconfig` per instructions below\n-   run `chmod u+x ./ziploy-cli`\n-   run `./ziploy-cli`\n\n## Configuration\n\nZiploy CLI is configured via a file named `.ziployconfig`. This file (or the `--config` flag) allows you to supply all necessary parameters without needing to type them as command‑line arguments.\n\n### Example `.ziployconfig` File\n\nBelow is a sample configuration file with all possible options and a brief description for each:\n\n```dot\n# .ziployconfig\n\n# Unique identifier for the deployment\nid = my-deploy-id\n\n# Remote host URL – must begin with http:// or https://\norigin = https://myexample.com\n\n# Deployment method: \"SSH\" or \"HTTP\"\nmethod = SSH\n\n# SSH configuration options (required if method is SSH)\nssh_host = myssh.example.com          # SSH host for remote operations\nssh_user = deployer                   # SSH username\nssh_port = 22                         # SSH port (default: 22)\nssh_key = /home/.ssh/id_rsa    # Optional Path to SSH private key (required if deploying from local machine)\nssh_known_hosts = /home/.ssh/known_hosts  # Optional path to known_hosts file (required if deploying from local machine)\n\n\n#############################################\n# Optional settings:\n# Maximum chunk size in bytes (default: 5 MB)\nchunk_size = 5242880\n```\n\nPlace the `.ziployconfig` file in your project root or pass its path explicitly with the `--config` flag when running the tool.\n\n## Ignoring Files\n\nTo exclude files and directories from the generated package, create a `.ziployignore` file. This file works similarly to a `.gitignore` file:\n\n-   Use glob patterns to specify what should be ignored.\n-   Lines beginning with a `#` are treated as comments.\n-   Patterns are defined relative to the project root.\n\n### Example `.ziployignore` File\n\n```dot\n# .ziployignore\n\n# Ignore swap files\n*.swp\n\n# Ignore Git files and directories\n.git*\n.gitignore\n\n# Optionally ignore the configuration file\n.ziployconfig\n\n# Ignore node_modules directory (often large and managed separately)\nnode_modules/\n\n# Ignore Python virtual environments\nvenv/\n\n# Ignore the temporary deployment output folder and ZIP file\n__to_ziploy/\n_ziploy.zip\n```\n\n## Usage\n\nOnce your configuration and ignore files are set up, you can deploy your application by running:\n\n```bash\n./ziploy-cli\n```\n\nThis command will:\n\n-   Read settings from the `.ziployconfig` file.\n-   Package your project while excluding files that match patterns in `.ziployignore`.\n-   Upload and deploy the application via the selected method to origin where Ziploy plugin is installed\n-   Provide progress updates and log output to both the console and a log file (ziploy.log).\n\n## Contributing\n\nPlease open an issue for bug fixes, improvements, or new features.\n\n## License\n\nThis project is licensed under the MIT License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcode-soup%2Fziploy-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcode-soup%2Fziploy-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcode-soup%2Fziploy-cli/lists"}