PHPackages ghostzero/bunny - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [CLI & Console](/categories/cli) 4. / 5. ghostzero/bunny ActiveProject[CLI & Console](/categories/cli) ghostzero/bunny =============== Replicate and store your files to the edge! 0.2.2(3y ago)20236[2 issues](https://github.com/own3d/bunny-cli/issues)Apache-2.0PHPPHP ^7.4|^8.0 Since Jul 19Pushed 2y ago1 watchersCompare [ Source](https://github.com/own3d/bunny-cli)[ Packagist](https://packagist.org/packages/ghostzero/bunny)[ Docs](https://github.com/ghostzero/bunny-cli)[ RSS](/packages/ghostzero-bunny/feed)WikiDiscussions main Synced 6d ago READMEChangelog (6)Dependencies (5)Versions (8)Used By (0) Bunny CLI - Replicate and store your files to the edge! ======================================================= [](#bunny-cli---replicate-and-store-your-files-to-the-edge) > Please use Bunny CLI for development purposes only. We have not yet released a stable release. What is Bunny CLI? ------------------ [](#what-is-bunny-cli) Bunny CLI is a tool for the console to upload frontend frameworks such as Angular, Vue.js, React, or more recently, Blazor quickly to the Edge Store on Bunny CDN. With Bunny CDN's Storage Edge, your web applications benefit from replicated storage zones, a global content delivery network that hosts files in 5 different regions worldwide and accelerates everything through a worldwide content delivery network with over 54+ PoPs. How do I use Bunny CLI? ----------------------- [](#how-do-i-use-bunny-cli) To install Bunny CLI, you need to be using Composer. For more details about Composer, see the [Composer documentation](https://getcomposer.org/doc/). ``` composer global require own3d/bunny-cli ``` If you want to update the Bunny CLI, just execute the following command: ``` composer global update own3d/bunny-cli ``` After you install Bunny CLI, the next step is typically run the `bunny init` command to perform initial setup tasks. You can also run `bunny init` at a later time to change your settings or create a new configuration. ### Run Bunny Init [](#run-bunny-init) To initialize Bunny CLI: 1. Run `bunny init`: ``` bunny init ``` 2. Configure your API credentials. In order for the Bunny CLI to work properly you need to store your Bunny CDN API token. You can find your API token in your [Account Settings](https://panel.bunny.net/account). 3. Choose a current Storage Zone if prompted. If you only have access to one storage zone, including the default pull zone, `bunny init` selects it for you. When `bunny init` finishes, it saves the environment variables in your .env file. You can view these environment variables at any other time using the `bunny env:list` command. ### Deploy your first project [](#deploy-your-first-project) With the `bunny deploy` command, you can easily synchronize your `dist` folder with your edge storage. > **IMPORTANT**: All files in the edge storage that are **not** in your local `dist` directory will be deleted. ``` ➜ $ bunny deploy - Hashing files... ✔ Finished hashing 16360 files - CDN diffing files... ✔ CDN requesting 10875 files - Synchronizing 10875 files 10875/10875 [============================] 100% ✔ Finished synchronizing 10875 files - Waiting for deploy to go live... ✔ Deployment is live! (322.96s) Website URL: https://bunny-cli.b-cdn.net/ ``` How do I integrate Bunny CLI into my GitHub Actions workflow? ------------------------------------------------------------- [](#how-do-i-integrate-bunny-cli-into-my-github-actions-workflow) We offer you a [GitHub Action for Bunny CLI](https://github.com/marketplace/actions/bunny-cli) for free. You can easily upload your distributable files to your edge storage during your deployment process with this action. Just put your storage password (`BUNNY_STORAGE_PASSWORD`) and your API key (`BUNNY_API_ACCESS_KEY`) in the secrets of your GitHub repository and adjust your workflow as follows. ``` - name: Deploy to Edge Storage uses: own3d/bunny-action@main env: BUNNY_API_ACCESS_KEY: ${{ secrets.BUNNY_API_ACCESS_KEY }} BUNNY_STORAGE_USERNAME: bunny-cli BUNNY_STORAGE_PASSWORD: ${{ secrets.BUNNY_STORAGE_PASSWORD }} BUNNY_STORAGE_PATH: some_target_edge_dir (optional) BUNNY_PULL_ZONE_ID: 466588 with: args: deploy --dir=dist ``` Environment Variables --------------------- [](#environment-variables) You can customize your environment file at any time. The following commands are available for this purpose: CommandDescription`env:list`List all current environment variables.`env:set {key} {value}`Set and save an environment variable in the .env file.`env:backup {file}`Backup .env file into a given file.`env:restore {file}`Restore .env file from a given file.Secure your `.well-known/bunny-cli.lock` file --------------------------------------------- [](#secure-your-well-knownbunny-clilock-file) Bunny CLI generates a lock file, which is located at `.well-known/bunny-cli.lock` by default. This file locks the files of your project to a known state. To prevent this from being publicly accessible it is recommended to create a new edge rule in your pull zone. You can use the following example as a template: Action: `Block Request` Condition Matching: `Match Any` Condition: If `Request URL` `Match Any` `*/.well-known/bunny-cli.lock` Now the file should no longer be accessible. It can take a few minutes until your Edge Rule is active. Frequently Asked Questions -------------------------- [](#frequently-asked-questions) ### Q: Is this a zero-downtime deployment? [](#q-is-this-a-zero-downtime-deployment) A: Depends. Only when the sync of the files is complete, the pull zone cache is cleared. Therefore if the CDN cache is not present because the cache has expired or miss, then an unanticipated event may occur. We hope that together with Bunny CDN, we can solve this problem. ### Q: Is this an official tool of Bunny CDN? [](#q-is-this-an-official-tool-of-bunny-cdn) A: No. Bunny CLI is a community-driven tool and is not affiliated with Bunny CDN. License ------- [](#license) Bunny CLI is an open-source software licensed under the Apache 2.0 license. ### Health Score 27 — LowBetter than 49% of packages Maintenance18 Infrequent updates — may be unmaintained Popularity18 Limited adoption so far Community12 Small or concentrated contributor base Maturity51 Maturing project, gaining track record Bus Factor1 Top contributor holds 96.7% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~124 days Recently: every ~155 days Total 6 Last Release 1143d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/03da561a330aa76d1a09096b2ee0c48ee53ca51d62fa0239469d9615b6855733?d=identicon)[ghostzero](/maintainers/ghostzero) --- Top Contributors [![ghostzero](https://avatars.githubusercontent.com/u/6547306?v=4)](https://github.com/ghostzero "ghostzero (29 commits)")[![Pimm](https://avatars.githubusercontent.com/u/78094?v=4)](https://github.com/Pimm "Pimm (1 commits)") --- Tags bunnycdncdncommand-line-toolstoragecliconsolecdnbunny ### Code Quality TestsPest ### Embed Badge ![Health badge](/badges/ghostzero-bunny/health.svg) ``` [![Health](https://phpackages.com/badges/ghostzero-bunny/health.svg)](https://phpackages.com/packages/ghostzero-bunny) ``` ### Alternatives [symfony/console Eases the creation of beautiful and testable command line interfaces 9.8k1.1B11.3k](/packages/symfony-console)[nunomaduro/collision Cli error handling for console/command-line PHP applications. 4.6k331.8M8.5k](/packages/nunomaduro-collision)[nunomaduro/termwind It's like Tailwind CSS, but for the console. 2.5k239.8M286](/packages/nunomaduro-termwind)[wp-cli/php-cli-tools Console utilities for PHP 68325.0M367](/packages/wp-cli-php-cli-tools)[php-school/cli-menu A command line menu helper in PHP 2.0k1.1M27](/packages/php-school-cli-menu)[seld/cli-prompt Allows you to prompt for user input on the command line, and optionally hide the characters they type 24725.8M17](/packages/seld-cli-prompt) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)