{"id":13669303,"url":"https://github.com/phalcon/phalcon-devtools","last_synced_at":"2025-05-12T13:08:23.577Z","repository":{"id":2783943,"uuid":"3783584","full_name":"phalcon/phalcon-devtools","owner":"phalcon","description":"Phalcon Developer Tools","archived":false,"fork":false,"pushed_at":"2025-03-24T17:31:00.000Z","size":20261,"stargazers_count":1330,"open_issues_count":34,"forks_count":629,"subscribers_count":130,"default_branch":"master","last_synced_at":"2025-04-23T09:52:43.405Z","etag":null,"topics":["devtools","hacktoberfest","ide","phalcon","phalcon-developer","phalcon-devtools","phalcon-framework","php","stubs"],"latest_commit_sha":null,"homepage":"https://docs.phalcon.io/latest/en/devtools","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/phalcon.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","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},"funding":{"github":"phalcon","open_collective":"phalcon"}},"created_at":"2012-03-21T05:18:46.000Z","updated_at":"2025-04-09T20:48:55.000Z","dependencies_parsed_at":"2024-08-02T08:05:01.502Z","dependency_job_id":"a515800d-2715-41b4-809f-dd3e8d17833b","html_url":"https://github.com/phalcon/phalcon-devtools","commit_stats":{"total_commits":1836,"total_committers":201,"mean_commits":9.134328358208956,"dds":0.7979302832244008,"last_synced_commit":"e3f1aeb6614b095afae854dc5b1b9a99ae886174"},"previous_names":[],"tags_count":63,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phalcon%2Fphalcon-devtools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phalcon%2Fphalcon-devtools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phalcon%2Fphalcon-devtools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phalcon%2Fphalcon-devtools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/phalcon","download_url":"https://codeload.github.com/phalcon/phalcon-devtools/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253745157,"owners_count":21957317,"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","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":["devtools","hacktoberfest","ide","phalcon","phalcon-developer","phalcon-devtools","phalcon-framework","php","stubs"],"created_at":"2024-08-02T08:01:09.187Z","updated_at":"2025-05-12T13:08:23.504Z","avatar_url":"https://github.com/phalcon.png","language":"JavaScript","funding_links":["https://github.com/sponsors/phalcon","https://opencollective.com/phalcon"],"categories":["PHP"],"sub_categories":[],"readme":"# Phalcon Devtools\n\n[![codecov](https://codecov.io/gh/phalcon/phalcon-devtools/branch/4.0.x/graph/badge.svg)](https://codecov.io/gh/phalcon/phalcon-devtools)\n[![Latest Version](https://img.shields.io/packagist/v/phalcon/devtools.svg?style=flat-square)][:devtools:]\n[![Software License](https://img.shields.io/badge/license-BSD--3-brightgreen.svg?style=flat-square)][:license:]\n[![Total Downloads](https://img.shields.io/packagist/dt/phalcon/devtools.svg?style=flat-square)][:packagist:]\n[![Daily Downloads](https://img.shields.io/packagist/dd/phalcon/devtools.svg?style=flat-square)][:packagist:]\n[![Build Status](https://api.travis-ci.org/phalcon/phalcon-devtools.svg?branch=master)][:travis:]\n\n![Phalcon WebTools](http://i.imgur.com/B3V2uSf.png)\n\n\n## What's Phalcon?\n\nPhalcon PHP is a web framework delivered as a C extension providing high performance and lower resource consumption.\n\n## What are Devtools?\n\nThis tools provide you useful scripts to generate code helping to develop faster and easy applications that use\nwith Phalcon framework.\n\n## Requirements\n\n* PHP \u003e= 7.2\n* Phalcon \u003e= 4.0.0\n\n## Installing via Composer\n\nInstall composer in a common location or in your project:\n\n```bash\ncurl -s http://getcomposer.org/installer | php\n```\n\nCreate the composer.json file as follows:\n\n```json\n{\n    \"require-dev\": {\n        \"phalcon/devtools\": \"~4.1\"\n    }\n}\n```\n\nIf you are still using Phalcon 3.4.x, create a `composer.json` with the following instead:\n\n```json\n{\n    \"require-dev\": {\n        \"phalcon/devtools\": \"^3.4\"\n    }\n}\n```\n\nRun the composer installer:\n\n```bash\nphp composer.phar install\n```\n\n## Build `.phar`\n\nInstall composer and box in a common location or in your project:\n```bash\ncurl -s http://getcomposer.org/installer | php\nbin/composer install\n```\n\nBuild phar file `phalcon-devtools`\n```bash\nbin/box build -v\nchmod +xr ./phalcon.phar\n# Test it!\nphp ./phalcon.phar\n```\n\n## Installation via Git\n\nPhalcon Devtools can be installed by using Git.\n\nJust clone the repo and checkout the current branch:\n\n```bash\ncd ~\ngit clone https://github.com/phalcon/phalcon-devtools.git\ncd phalcon-devtools\n```\n\nThis method requires a little bit more of setup. Probably the best way would be to symlink\nthe `phalcon` file to a directory in your `PATH`, so you can issue phalcon commands in each directory\nwhere a phalcon project resides.\n\n```bash\ncd phalcon-devtools\ncomposer install\nln -s $(pwd)/phalcon /usr/bin/phalcon\nchmod ugo+x /usr/bin/phalcon\n```\n\nIf you get a `\"phalcon: command not found\"` message while creating the symlink, make an alias.\n\n```bash\nalias phalcon=/home/[USERNAME]/phalcon-devtools/phalcon\n```\n\n## Usage\n\nTo get a list of available commands just execute following:\n\n```bash\nphalcon commands help\n```\n\nThis command should display something similar to:\n\n```sh\n$ phalcon --help\n\nPhalcon DevTools (4.1.0)\n\nHelp:\n  Lists the commands available in Phalcon DevTools\n\nAvailable commands:\n  info             (alias of: i)\n  commands         (alias of: list, enumerate)\n  controller       (alias of: create-controller)\n  module           (alias of: create-module)\n  model            (alias of: create-model)\n  all-models       (alias of: create-all-models)\n  project          (alias of: create-project)\n  scaffold         (alias of: create-scaffold)\n  migration        (alias of: create-migration)\n  webtools         (alias of: create-webtools)\n  serve            (alias of: server)\n  console          (alias of: shell, psysh)\n```\n\n## Database adapter\n\nShould add `adapter` parameter in your `db` config file (if you use not MySQL database).\n\nFor PostgreSQL it will be something like:\n\n```php\n$config = [\n  'host'     =\u003e 'localhost',\n  'dbname'   =\u003e 'my_db_name',\n  'username' =\u003e 'my_db_user',\n  'password' =\u003e 'my_db_user_password',\n  'adapter'  =\u003e 'Postgresql'\n];\n```\n\n## Configuration file\n\nBy creating **config.json** or any other configuration file called **config** in root project you can set options for all possible commands, for example:\n\n```json\n{\n  \"migration\" : {\n    \"migrations\": \"App/Migrations\",\n    \"config\": \"App/Config/db.ini\"\n  },\n  \"controller\" : {\n    \"namespace\": \"Phalcon\\\\Test\",\n    \"directory\": \"App/Controllers\",\n    \"base-class\": \"App\\\\MyAbstractController\"\n  }\n}\n```\n\nAnd then you can use `phalcon migration run` or `phalcon controller SomeClass` and those commands will be executed with options from file. Arguments provided by developer from command line will overwrite existing one in a file.\n\n## License\n\nPhalcon Developer Tools is open source software licensed under the [New BSD License][:license:].\u003cbr\u003e\n© Phalcon Framework Team and contributors\n\n[:packagist:]: https://packagist.org/packages/phalcon/devtools\n[:devtools:]: https://github.com/phalcon/phalcon-devtools\n[:license:]: https://github.com/phalcon/phalcon-devtools/blob/master/LICENSE.txt\n[:travis:]: https://travis-ci.org/phalcon/phalcon-devtools\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphalcon%2Fphalcon-devtools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fphalcon%2Fphalcon-devtools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphalcon%2Fphalcon-devtools/lists"}