PHPackages ggedde/spry-cli - 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. ggedde/spry-cli ActiveCli[CLI & Console](/categories/cli) ggedde/spry-cli =============== Command Line Interface for spry 1.0.21(6y ago)156MITPHPPHP >=5.5.0 Since Jul 13Pushed 6y ago1 watchersCompare [ Source](https://github.com/ggedde/spry-cli)[ Packagist](https://packagist.org/packages/ggedde/spry-cli)[ RSS](/packages/ggedde-spry-cli/feed)WikiDiscussions master Synced 2d ago READMEChangelogDependenciesVersions (53)Used By (0) SpryCli ======= [](#sprycli) Command Line Interface for Spry [![GitHub tag (latest by date)](https://camo.githubusercontent.com/904355aac19706aaab0a84bdbe54570ca036d949d6eaa33ae02faa7a9ea04a0e/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f7461672f6767656464652f737072792d636c69)](https://camo.githubusercontent.com/904355aac19706aaab0a84bdbe54570ca036d949d6eaa33ae02faa7a9ea04a0e/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f7461672f6767656464652f737072792d636c69) [![GitHub](https://camo.githubusercontent.com/5b73d68986fc9f7be835d6311ea2b279f77071f0063d7eca847f0daec2e38c3e/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f6767656464652f737072793f6c6162656c3d6c6963656e7365)](https://camo.githubusercontent.com/5b73d68986fc9f7be835d6311ea2b279f77071f0063d7eca847f0daec2e38c3e/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f6767656464652f737072793f6c6162656c3d6c6963656e7365) [![PHP from Packagist](https://camo.githubusercontent.com/6d4eec3a32c8c50a6628e780c7102e7d68d07e1f3b656677706d46c7578c25d5/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f6767656464652f73707279)](https://camo.githubusercontent.com/6d4eec3a32c8c50a6628e780c7102e7d68d07e1f3b656677706d46c7578c25d5/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f6767656464652f73707279) Installation ============ [](#installation) ``` composer global require ggedde/spry-cli ``` You also need to make sure you have the global composer bin available in your ~/.bash\_profile or ~/.bashrc depending on what OS your using. Edit one of those files and check to see if this exists. If not then add it to the bottome of the file. ``` export PATH="$PATH:$HOME/.composer/vendor/bin" ``` You may have to close and reopen your terminal or you can run ``` source ~/.bash_profile ``` or ``` source ~/.bashrc ``` Create a project ---------------- [](#create-a-project) ``` spry new [project_name] cd [project_name] ``` To Start the Test server run ``` spry up ``` Then open another termal and run a test ``` spry test ``` List of Commands and arguments: =============================== [](#list-of-commands-and-arguments) **clear** \[*object*\] ---------------------- [](#clear--object) \[*object*\] - Object name. Currently only supports 'logs'. - *logs* - clears both API and PHP log files. Does not remove archived logs. ###### *Examples:* [](#examples) ``` spry clear logs ``` **component** | **c** \[*component*\] ------------------------------------- [](#component--c--component) Generate a new Component and add it to your component directory. \[*component*\] - Name of component to create. Name will be parsed into psr-4 format. ###### *Examples:* [](#examples-1) ``` spry component sales_reps spry component SalesReps ``` **hash** | **h** \[*value*\] ---------------------------- [](#hash--h--value) Hash a value that processes it using the salt in the configuration. \[*value*\] - Value to be hashed. Wrap with quotes when including spaces. ###### *Examples:* [](#examples-2) ``` spry hash "something to hash 123" ``` **help** | **-h** | **--help** ------------------------------ [](#help---h----help) Display Information about Spry-cli. ###### *Examples:* [](#examples-3) ``` spry help ``` **init** | **i** \[*public\_folder*\] ------------------------------------- [](#init--i--public_folder) Initiate a Spry Setup and Configuration with a default project setup. \[*public\_folder*\] - *(optional)* - creates a folder of that name and adds a index.php pointer file ###### *Examples:* [](#examples-4) ``` spry init spry init public_html ``` **logs** | **l** \[*type*\] \[*--options*\] ------------------------------------------- [](#logs--l--type---options) Display Contents of log files by type. \[*type*\] - Type of logs to display. Corresponds to your configuration logs. - *php* - Checks the php log file configured as $config->log\_php\_file. - *api* - Checks the api log file configured as $config->log\_api\_file. ###### *Options:* [](#options) - *--lines* - Default 100. Number of lines to display. - *--trace* - Only applies to 'type=php'. Shows Trace in logs. ###### *Examples:* [](#examples-5) ``` spry logs api spry logs php --lines 10 --trace ``` **migrate** | **m** \[*--options*\] ----------------------------------- [](#migrate--m---options) Migrate the Database Schema. ###### *Options:* [](#options-1) - *--dryrun | -d* - Only check for what will be migrated and report back. No actions will be taken. - *--force | -f* - (Destructive) Delete Fields, Tables and other data that does not match the new Scheme. ###### *Examples:* [](#examples-6) ``` spry migrate spry migrate --dryrun spry migrate --force ``` **new** | **n** \[*project*\] ----------------------------- [](#new--n-project) Create a new project/directory and initiate it. \[*project*\] - Name of project/directory to create and initialize. ###### *Examples:* [](#examples-7) ``` spry new project_name ``` **test** | **t** \[*test*\] \[*--options*\] ------------------------------------------- [](#test--t-test---options) Run a Test or all Tests if a Test name is not specified. \[*test*\] - *(optional)* - Name of a Test in configuration or json test data. Leave out to run all tests in configuration. ###### *Options:* [](#options-2) - *--verbose* - List out full details of the Test(s). - *--repeat* - Repeat the test(s) a number of times. ###### *Examples:* [](#examples-8) ``` spry test spry test --verbose spry test connection --verbose --repeat 4 spry test '{"route":"/example/add", "params":{"name":"test"}, "expect":{"response_code": 2000}}' ``` **version** | **v** | **-v** | **--version** -------------------------------------------- [](#version--v---v----version) Display the Version of the Spry Instalation. ###### *Examples:* [](#examples-9) ``` spry version ``` **up** | **u** -------------- [](#up--u) Start the built in PHP Spry Server. ###### *Examples:* [](#examples-10) ``` spry up ``` ### Health Score 30 — LowBetter than 62% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity10 Limited adoption so far Community7 Small or concentrated contributor base Maturity71 Established project with proven stability Bus Factor1 Top contributor holds 100% 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 ~20 days Recently: every ~6 days Total 52 Last Release 2227d ago Major Versions 0.9.29 → 1.0.02020-03-03 PHP version history (2 changes)0.9.1PHP >=5.4.0 1.0.1PHP >=5.5.0 ### Community Maintainers ![](https://www.gravatar.com/avatar/459f086623b58e334ff8f569a9cedaf847ff4fef97b1c9aceabb618f9e2006fa?d=identicon)[ggedde](/maintainers/ggedde) --- Top Contributors [![ggedde](https://avatars.githubusercontent.com/u/3236909?v=4)](https://github.com/ggedde "ggedde (105 commits)") ### Embed Badge ![Health badge](/badges/ggedde-spry-cli/health.svg) ``` [![Health](https://phpackages.com/badges/ggedde-spry-cli/health.svg)](https://phpackages.com/packages/ggedde-spry-cli) ``` ### Alternatives [illuminate/console The Illuminate Console package. 13046.0M6.3k](/packages/illuminate-console)[styleci/cli The CLI tool for StyleCI 71464.1k9](/packages/styleci-cli)[winbox/args Windows command-line formatter 20718.9k21](/packages/winbox-args) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)