{"id":20176591,"url":"https://github.com/phpmv/ubiquity-devtools","last_synced_at":"2025-03-17T03:05:59.202Z","repository":{"id":57040641,"uuid":"88345847","full_name":"phpMv/ubiquity-devtools","owner":"phpMv","description":"Command line tools for Ubiquity framework","archived":false,"fork":false,"pushed_at":"2024-09-16T22:31:59.000Z","size":724,"stargazers_count":14,"open_issues_count":0,"forks_count":10,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-11T05:35:06.986Z","etag":null,"topics":["composer","ubiquity-devtools","ubiquity-framework"],"latest_commit_sha":null,"homepage":"https://ubiquity.kobject.net","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/phpMv.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":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-04-15T12:35:16.000Z","updated_at":"2024-09-16T22:32:02.000Z","dependencies_parsed_at":"2024-09-16T21:03:40.286Z","dependency_job_id":"b7eab75d-1f17-4754-a5ed-8094477d1884","html_url":"https://github.com/phpMv/ubiquity-devtools","commit_stats":null,"previous_names":[],"tags_count":59,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phpMv%2Fubiquity-devtools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phpMv%2Fubiquity-devtools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phpMv%2Fubiquity-devtools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phpMv%2Fubiquity-devtools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/phpMv","download_url":"https://codeload.github.com/phpMv/ubiquity-devtools/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243965768,"owners_count":20375916,"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":["composer","ubiquity-devtools","ubiquity-framework"],"created_at":"2024-11-14T02:10:11.813Z","updated_at":"2025-03-17T03:05:59.181Z","avatar_url":"https://github.com/phpMv.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"![img](https://github.com/phpmv/ubiquity-devtools/blob/master/.github/images/devtools.png?raw=true)\n\n[![Latest Stable Version](https://poser.pugx.org/phpmv/ubiquity-devtools/v/stable)](https://packagist.org/packages/phpmv/ubiquity-devtools)\n[![Total Downloads](https://poser.pugx.org/phpmv/ubiquity-devtools/downloads)](https://packagist.org/packages/phpmv/ubiquity-devtools)\n[![License](https://poser.pugx.org/phpmv/ubiquity-devtools/license)](https://packagist.org/packages/phpmv/ubiquity-devtools)\n[![Documentation Status](https://readthedocs.org/projects/micro-framework/badge/?version=latest)](http://micro-framework.readthedocs.io/en/latest/?badge=latest)\n\nCommand line tools for [Ubiquity framework](https://github.com/phpMv/ubiquity)\n## I - Installation\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```\nRun the composer installer :\n\n```bash\ncomposer global require phpmv/ubiquity-devtools\n```\nMake sure to place the `~/.composer/vendor/bin` directory in your PATH so the **Ubiquity** executable can be located by your system.\n\nTo confirm **Ubiquity** was successfully installed, type ``Ubiquity version``:\n\n![img](https://github.com/phpmv/ubiquity-devtools/blob/master/.github/images/devtools-version.png)\n\n\u003cdetails\u003e\n        \u003csummary\u003eIf you get the message \u003cb\u003eUbiquity command not found\u003c/b\u003e\u003c/summary\u003e\n        Add composer's \u003ccode\u003ebin\u003c/code\u003e directory to the system path\n        \u003cul\u003e\n                \u003cli\u003eOn windows\n                        \u003cul\u003e\u003cli\u003e\n                                by adding the value \u003ccode\u003e%USERPROFILE%\\AppData\\Roaming\\Composer\\vendor\\bin\u003c/code\u003e to the system PATH variable\n                        \u003c/li\u003e\u003c/ul\u003e\n                \u003c/li\u003e\n                \u003cli\u003eOn other systems\n                        \u003cul\u003e\u003cli\u003e\n                                by placing \u003ccode\u003eexport PATH=\"$HOME/.composer/vendor/bin:$PATH\"\u003c/code\u003e into your \u003ccode\u003e~/.bash_profile\u003c/code\u003e (Mac OS users) or into your \u003ccode\u003e~/.bashrc\u003c/code\u003e (Linux users).\n                        \u003c/li\u003e\u003c/ul\u003e\n                \u003c/li\u003e\n        \u003c/ul\u003e\n\u003c/details\u003e\n\n## II Devtools commands\n### Information\nTo get a list of available commands just run in console:\n```bash\nUbiquity help\n```\nThis command should display something similar to:\n\n```bash\nUbiquity devtools (1.3.6)\n\n■ init-cache [] =\u003e\n        · Init the cache for models, router, rest.\n        · Aliases : init_cache,init:cache,initCache\n        · Parameters :\n                -t      shortcut of --type\n                        Defines the type of cache to create.\n                        Possibles values :\n                        all,controllers,acls,rest,models\n                        Default : [all]\n\n        × Samples :\n                Init all caches\n                  · Ubiquity init-cache\n                Init models cache\n                  · Ubiquity init-cache -t=models\n\n■ clear-cache [] =\u003e\n        · Clear models cache.\n        · Aliases : clear_cache,clear:cache,clearCache\n        · Parameters :\n                -t      shortcut of --type\n                        Defines the type of cache to reset.\n                        Possibles values :\n                        all,annotations,controllers,rest,models,queries,views\n                        Default : [all]\n\n        × Samples :\n                Clear all caches\n                  · Ubiquity clear-cache -t=all\n                Clear models cache\n                  · Ubiquity clear-cache -t=models\n\n■ controller [controllerName] =\u003e\n        · Creates a new controller.\n        · Aliases : create_controller,create:controller,create-controller,createController\n        · Parameters :\n                -v      shortcut of --views\n                        creates an associated view folder and index.html\n                        Possibles values :\n                        true,false\n                        Default : [false]\n\n                -o      shortcut of --domain\n                        The domain in which to create the controller.\n\n        × Samples :\n                Creates a controller\n                  · Ubiquity controller UserController\n                with its associated view\n                  · Ubiquity controller UserController -v\n                Creates a controller in the orga domain\n                  · Ubiquity controller OrgaController -o=orga\n\n■ action [controller.action] =\u003e\n        · Creates a new action in a controller.\n        · Aliases : new-action,new_action,new:action,newAction\n        · Parameters :\n                -p      shortcut of --params\n                        The action parameters (or arguments)\n\n                -r      shortcut of --route\n                        The associated route path\n\n                -v      shortcut of --create-view\n                        Creates the associated view\n                        Possibles values :\n                        true,false\n                        Default : [false]\n\n                -o      shortcut of --domain\n                        The domain in which the controller is.\n\n        × Samples :\n                Adds the action all in controller Users\n                  · Ubiquity action Users.all\n                Adds the action display in controller Users with a parameter\n                  · Ubiquity action Users.display -p=idUser\n                and associates a route to it\n                  · Ubiquity action Users.display -p=idUser -r=/users/display/{idUser}\n                with multiple parameters\n                  · Ubiquity action Users.search -p=name,address\n                and create the associated view\n                  · Ubiquity action Users.search -p=name,address -v\n\n■ auth [authControllerName] =\u003e\n        · Creates a new controller for authentification.\n        · Aliases : auth-controller,auth_controller,auth:controller,authController\n        · Parameters :\n                -e      shortcut of --extends\n                        The base class of the controller (must derived from AuthController)\n                        Default : [Ubiquity\\controllers\\auth\\AuthController]\n\n                -t      shortcut of --templates\n                        The templates to modify\n                        Possibles values :\n                        index,info,noAccess,disconnected,message,baseTemplate\n                        Default : [index,info,noAccess,disconnected,message,baseTemplate]\n\n                -p      shortcut of --path\n                        The associated route\n\n                -o      shortcut of --domain\n                        The domain in which to create the controller.\n\n        × Samples :\n                Creates a new controller for authentification\n                  · Ubiquity auth AdminAuthController\n                and associates a route to it\n                  · Ubiquity auth AdminAuthController -p=/admin/auth\n                allows customization of index and info templates\n                  · Ubiquity auth AdminAuthController -t=index,info\n\n■ crud-index [crudControllerName] =\u003e\n        · Creates a new index-CRUD controller.\n        · Aliases : crud-index-controller,crud_index,crud:index,crudIndex\n        · Parameters :\n                -d      shortcut of --datas\n                        The associated Datas class\n                        Possibles values :\n                        true,false\n                        Default : [true]\n\n                -v      shortcut of --viewer\n                        The associated Viewer class\n                        Possibles values :\n                        true,false\n                        Default : [true]\n\n                -e      shortcut of --events\n                        The associated Events class\n                        Possibles values :\n                        true,false\n                        Default : [true]\n\n                -t      shortcut of --templates\n                        The templates to modify\n                        Possibles values :\n                        index,form,display,item,itemHome\n                        Default : [index,form,display,home,itemHome]\n\n                -p      shortcut of --path\n                        The associated route\n                        Default : [{resource}]\n\n                -o      shortcut of --domain\n                        The domain in which to create the controller.\n\n        × Samples :\n                Creates an index crud controller\n                  · Ubiquity crud-index MainCrud -p=crud/{resource}\n                allows customization of index and form templates\n                  · Ubiquity index-crud MainCrud -t=index,form\n\n■ crud [crudControllerName] =\u003e\n        · Creates a new CRUD controller.\n        · Aliases : crud_controller,crud:controller,crud-controller,crudController\n        · Parameters :\n                -r      shortcut of --resource\n                        The model used\n\n                -d      shortcut of --datas\n                        The associated Datas class\n                        Possibles values :\n                        true,false\n                        Default : [true]\n\n                -v      shortcut of --viewer\n                        The associated Viewer class\n                        Possibles values :\n                        true,false\n                        Default : [true]\n\n                -e      shortcut of --events\n                        The associated Events class\n                        Possibles values :\n                        true,false\n                        Default : [true]\n\n                -t      shortcut of --templates\n                        The templates to modify\n                        Possibles values :\n                        index,form,display\n                        Default : [index,form,display]\n\n                -p      shortcut of --path\n                        The associated route\n\n                -o      shortcut of --domain\n                        The domain in which to create the controller.\n\n        × Samples :\n                Creates a crud controller for the class models\\User\n                  · Ubiquity crud CrudUsers -r=User\n                and associates a route to it\n                  · Ubiquity crud CrudUsers -r=User -p=/users\n                allows customization of index and form templates\n                  · Ubiquity crud CrudUsers -r=User -t=index,form\n                Creates a crud controller for the class models\\projects\\Author\n                  · Ubiquity crud Authors -r=models\\projects\\Author\n\n■ new-class [name] =\u003e\n        · Creates a new class.\n        · Aliases : new_class,new:class,newClass,class\n        · Parameters :\n                -p      shortcut of --parent\n                        The class parent.\n\n        × Samples :\n                Creates a new class\n                  · Ubiquity class services.OrgaRepository\n\n■ create-theme [themeName] =\u003e\n        · Creates a new theme or installs an existing one.\n        · Aliases : create_theme,create:theme,createTheme\n        · Parameters :\n                -x      shortcut of --extend\n                        If specified, inherits from an existing theme (bootstrap,semantic or foundation).\n                        Possibles values :\n                        bootstrap,semantic,foundation\n\n                -o      shortcut of --domain\n                        The domain in which to create the theme.\n\n        × Samples :\n                Creates a new theme custom\n                  · Ubiquity create-theme custom\n                Creates a new theme inheriting from Bootstrap\n                  · Ubiquity theme myBootstrap -x=bootstrap\n\n■ theme [themeName] =\u003e\n        · Installs an existing theme or creates a new one if the specified theme does not exists.\n        · Aliases : install_theme,install-theme,install:theme,installTheme\n        · Parameters :\n                -o      shortcut of --domain\n                        The domain in which to install the theme.\n\n        × Samples :\n                Creates a new theme custom\n                  · Ubiquity theme custom\n                Install bootstrap theme\n                  · Ubiquity theme bootstrap\n\n■ project [projectName] =\u003e\n        · Creates a new #ubiquity project.\n        · Aliases : new,create_project\n        · Parameters :\n                -b      shortcut of --dbName\n                        Sets the database name.\n\n                -s      shortcut of --serverName\n                        Defines the db server address.\n                        Default : [127.0.0.1]\n\n                -p      shortcut of --port\n                        Defines the db server port.\n                        Default : [3306]\n\n                -u      shortcut of --user\n                        Defines the db server user.\n                        Default : [root]\n\n                -w      shortcut of --password\n                        Defines the db server password.\n\n                -h      shortcut of --themes\n                        Install themes.\n                        Possibles values :\n                        semantic,bootstrap,foundation\n\n                -m      shortcut of --all-models\n                        Creates all models from database.\n\n                -a      shortcut of --admin\n                        Adds UbiquityMyAdmin tool.\n                        Possibles values :\n                        true,false\n                        Default : [false]\n\n                -i      shortcut of --siteUrl\n                        Sets the site base URL.\n\n                -e      shortcut of --rewriteBase\n                        Sets .htaccess file rewriteBase.\n\n        × Samples :\n                Creates a new project\n                  · Ubiquity new blog\n                With admin interface\n                  · Ubiquity new blog -a\n                and models generation\n                  · Ubiquity new blog -a -m -b=blogDB\n\n■ serve [] =\u003e\n        · Start a web server.\n        · Parameters :\n                -h      shortcut of --host\n                        Sets the host ip address.\n                        Default : [127.0.0.1]\n\n                -p      shortcut of --port\n                        Sets the listen port number.\n                        Default : [8090]\n\n                -n      shortcut of --nolr\n                        Starts without live-reload.\n\n                -l      shortcut of --lrport\n                        Sets the live-reload listen port number.\n                        Default : [35729]\n\n                -t      shortcut of --type\n                        Sets the server type.\n                        Possibles values :\n                        php,react,swoole,roadrunner\n                        Default : [php]\n\n        × Samples :\n                Starts a php server at 127.0.0.1:8090\n                  · Ubiquity serve\n                Starts a reactPHP server at 127.0.0.1:8080\n                  · Ubiquity serve -t=react\n\n■ livereload [path] =\u003e\n        · Start the live reload server.\n        · Aliases : live-reload,live\n        · Parameters :\n                -p      shortcut of --port\n                        Sets the listen port number.\n                        Default : [35729]\n\n                -e      shortcut of --exts\n                        Specify extentions to observe .\n                        Default : [php,html]\n\n                -x      shortcut of --exclusions\n                        Exclude file matching pattern .\n                        Default : [cache/,logs/]\n\n        × Samples :\n                Starts the live-reload server at 127.0.0.1:35729\n                  · Ubiquity live-reload\n                Starts the live-reload server at 127.0.0.1:35800 excluding logs directory\n                  · Ubiquity live-reload -p=35800 -x=logs/\n\n■ bootstrap [command] =\u003e\n        · Executes a command created in app/config/_bootstrap.php file for bootstraping the app.\n        · Aliases : boot\n        × Samples :\n                Bootstrap for dev mode\n                  · Ubiquity bootstrap dev\n                Bootstrap for prod mode\n                  · Ubiquity bootstrap prod\n\n■ help [?] =\u003e\n        · Get some help about a dev-tools command.\n        × Samples :\n                Get some help about crud\n                  · Ubiquity help crud\n\n■ version [] =\u003e\n        · Return PHP, Framework and dev-tools versions.\n\n■ model [modelName] =\u003e\n        · Generates models from scratch.\n        · Aliases : create_model,create:model,create-model,createModel,new_model,new:model,new-model,newModel\n        · Parameters :\n                -d      shortcut of --database\n                        The database connection to use\n                        Default : [default]\n\n                -o      shortcut of --domain\n                        The domain in which to create the model.\n\n                -k      shortcut of --autoincPk\n                        The default primary key defined as autoinc.\n                        Default : [id]\n\n        × Samples :\n                  · Ubiquity model User\n                  · Ubiquity model Author -d=projects\n                  · Ubiquity model Group,User -o=orga\n\n■ genModel [tableName] =\u003e\n        · Generates a new model from an existing table.\n        · Aliases : gen_model,gen:model,gen-model,genModel\n        · Parameters :\n                -d      shortcut of --database\n                        The database connection to use\n                        Default : [default]\n\n                -a      shortcut of --access\n                        The default access to the class members\n                        Default : [private]\n\n                -o      shortcut of --domain\n                        The domain in which to create the model.\n\n        × Samples :\n                  · Ubiquity genModel User\n                  · Ubiquity genModel Author -d=projects\n                  · Ubiquity genModel Author -d=projects -a=protected\n\n■ all-models [] =\u003e\n        · Generates all models from database.\n        · Aliases : create-all-models,all_models,all:models,allModels\n        · Parameters :\n                -d      shortcut of --database\n                        The database connection to use (offset)\n                        Default : [default]\n\n                -a      shortcut of --access\n                        The default access to the class members\n                        Default : [private]\n\n                -o      shortcut of --domain\n                        The domain in which to create the models.\n\n        × Samples :\n                  · Ubiquity all-models\n                  · Ubiquity all-models -d=projects\n                  · Ubiquity all-models -d=projects -a=protected\n\n■ info-migrations [] =\u003e\n        · Returns the migration infos.\n        · Aliases : info_migrations,info:migrations,infoMigrations\n        · Parameters :\n                -d      shortcut of --database\n                        The database offset.\n                        Default : [default]\n\n                -o      shortcut of --domain\n                        The domain in which the database models are.\n\n        × Samples :\n                Display all migrations for the default database\n                  · Ubiquity info:migrations\n\n■ migrations [] =\u003e\n        · Display and execute the database migrations.\n        · Aliases : migrations,migrate\n        · Parameters :\n                -d      shortcut of --database\n                        The database offset.\n                        Default : [default]\n\n                -o      shortcut of --domain\n                        The domain in which the database models are.\n\n        × Samples :\n                Display and execute all migrations for the default database\n                  · Ubiquity migrations\n\n■ dao [command] =\u003e\n        · Executes a DAO command (getAll,getOne,count,uGetAll,uGetOne,uCount).\n        · Aliases : DAO\n        · Parameters :\n                -r      shortcut of --resource\n                        The model used\n\n                -c      shortcut of --condition\n                        The where part of the query\n\n                -i      shortcut of --included\n                        The associated members to load (boolean or array: client.*,commands)\n\n                -p      shortcut of --parameters\n                        The parameters for a parameterized query\n\n                -f      shortcut of --fields\n                        The fields to display in the response\n\n                -o      shortcut of --domain\n                        The domain in which the models are.\n\n        × Samples :\n                Returns all instances of models\\User\n                  · Ubiquity dao getAll -r=User\n                Returns all instances of models\\User and includes their commands\n                  · Ubiquity dao getAll -r=User -i=commands\n                Returns the User with the id 5\n                  · Ubiquity dao getOne -c=\"id=5\"-r=User\n                Returns the list of users belonging to the \"Brittany\" or \"Normandy\" regions\n                  · Ubiquity uGetAll -r=User -c=\"region.name= ? or region.name= ?\" -p=Brittany,Normandy\n\n■ self-update [] =\u003e\n        · Updates Ubiquity framework for the current project.\n\n■ composer [command] =\u003e\n        · Executes a composer command.\n        · Aliases : compo\n        × Samples :\n                composer update\n                  · Ubiquity composer update\n                composer update with no-dev\n                  · Ubiquity composer nodev\n                composer optimization for production\n                  · Ubiquity composer optimize\n\n■ admin [] =\u003e\n        · Add UbiquityMyAdmin webtools to the current project.\n\n■ rest [restControllerName] =\u003e\n        · Creates a new REST controller.\n        · Aliases : rest-controller,rest:controller,rest_controller,restController\n        · Parameters :\n                -r      shortcut of --resource\n                        The model used\n\n                -p      shortcut of --path\n                        The associated route\n\n                -o      shortcut of --domain\n                        The domain in which to create the controller.\n\n        × Samples :\n                Creates a REST controller for the class models\\User\n                  · Ubiquity rest RestUsers -r=User -p=/rest/users\n\n■ restapi [restControllerName] =\u003e\n        · Creates a new REST API controller.\n        · Aliases : restapi-controller,restapi:controller,restapi_controller,restapiController\n        · Parameters :\n                -p      shortcut of --path\n                        The associated route\n\n                -o      shortcut of --domain\n                        The domain in which to create the controller.\n\n        × Samples :\n                Creates a REST API controller\n                  · Ubiquity restapi -p=/rest\n\n■ info-routes [] =\u003e\n        · Display the cached routes.\n        · Aliases : info:r,info_routes,info:routes,infoRoutes\n        · Parameters :\n                -t      shortcut of --type\n                        Defines the type of routes to display.\n                        Possibles values :\n                        all,routes,rest\n\n                -l      shortcut of --limit\n                         Specifies the number of routes to return.\n\n                -o      shortcut of --offset\n                        Specifies the number of routes to skip before starting to return.\n\n                -s      shortcut of --search\n                        Search routes corresponding to a path.\n\n                -m      shortcut of --method\n                        Allows to specify a method with search attribute.\n                        Possibles values :\n                        get,post,put,delete,patch\n\n        × Samples :\n                All routes\n                  · Ubiquity info:routes\n                Rest routes\n                  · Ubiquity info:routes -type=rest\n                Only the routes with the method post\n                  · Ubiquity info:routes -type=rest -m=-post\n\n■ info-model [?infoType] =\u003e\n        · Returns the model meta datas.\n        · Aliases : info_model,info:model,infoModel\n        · Parameters :\n                -s      shortcut of --separate\n                        If true, returns each info in a separate table\n                        Possibles values :\n                        true,false\n                        Default : [false]\n\n                -m      shortcut of --model\n                        The model on which the information is sought.\n\n                -f      shortcut of --fields\n                        The fields to display in the table.\n\n                -o      shortcut of --domain\n                        The domain in which the models is.\n\n        × Samples :\n                Gets metadatas for User class\n                  · Ubiquity info:model -m=User\n\n■ info-models [] =\u003e\n        · Returns the models meta datas.\n        · Aliases : info_models,info:models,infoModels\n        · Parameters :\n                -d      shortcut of --database\n                        The database connection to use (offset)\n                        Default : [default]\n\n                -m      shortcut of --models\n                        The models on which the information is sought.\n\n                -f      shortcut of --fields\n                        The fields to display in the table.\n\n                -o      shortcut of --domain\n                        The domain in which the models are.\n\n        × Samples :\n                Gets metadatas for all models in default db\n                  · Ubiquity info:models\n                Gets metadatas for all models in messagerie db\n                  · Ubiquity info:models -d=messagerie\n                Gets metadatas for User and Group models\n                  · Ubiquity info:models -m=User,Group\n                Gets all primary keys for all models\n                  · Ubiquity info:models -f=#primaryKeys\n\n■ info-validation [?memberName] =\u003e\n        · Returns the models validation info.\n        · Aliases : info_validation,info:validation,infoValidation,info_validators,info-validators,info:validators,infoValidators\n        · Parameters :\n                -s      shortcut of --separate\n                        If true, returns each info in a separate table\n                        Possibles values :\n                        true,false\n                        Default : [false]\n\n                -m      shortcut of --model\n                        The model on which the information is sought.\n\n                -o      shortcut of --domain\n                        The domain in which the models is.\n\n        × Samples :\n                Gets validators for User class\n                  · Ubiquity info:validation -m=User\n                Gets validators for User class on member firstname\n                  · Ubiquity info:validation firstname -m=User\n\n■ config [] =\u003e\n        · Returns the config informations from app/config/config.php.\n        · Aliases : info_config,info-config,info:config,infoConfig\n        · Parameters :\n                -f      shortcut of --fields\n                        The fields to display.\n\n        × Samples :\n                Display all config vars\n                  · Ubiquity config\n                Display database config vars\n                  · Ubiquity config -f=database\n\n■ config-set [] =\u003e\n        · Modify/add variables and save them in app/config/config.php. Supports only long parameters with --.\n        · Aliases : set_config,set-config,set:config,setConfig\n        × Samples :\n                Assigns a new value to siteURL\n                  · Ubiquity config:set --siteURL=http://127.0.0.1/quick-start/\n                Change the database name and port\n                  · Ubiquity config:set --database.dbName=blog --database.port=3307\n\n■ mailer [part] =\u003e\n        · Displays mailer classes, mailer queue or mailer dequeue.\n        × Samples :\n                Display mailer classes\n                  · Ubiquity mailer classes\n                Display mailer messages in queue(To send)\n                  · Ubiquity mailer queue\n                Display mailer messages in dequeue(sent)\n                  · Ubiquity mailer dequeue\n\n■ new-mail [name] =\u003e\n        · Creates a new mailer class.\n        · Aliases : new_mail,new:mail,newMail\n        · Parameters :\n                -p      shortcut of --parent\n                        The class parent.\n                        Default : [\\Ubiquity\\mailer\\AbstractMail]\n\n                -v      shortcut of --view\n                        Add the associated view.\n\n        × Samples :\n                Creates a new mailer class\n                  · Ubiquity newMail InformationMail\n\n■ send-mail [] =\u003e\n        · Send message(s) from queue.\n        · Aliases : send-mails,send_mails,send:mails,sendMails\n        · Parameters :\n                -n      shortcut of --num\n                        If specified, Send the mail at the position n in queue.\n\n        × Samples :\n                Send all messages to send from queue\n                  · Ubiquity semdMails\n                Send the first message in queue\n                  · Ubiquity sendMail 1\n\n■ create-command [commandName] =\u003e\n        · Creates a new custom command for the devtools.\n        · Aliases : create_command,create:command,createCommand\n        · Parameters :\n                -v      shortcut of --value\n                        The command value (first parameter).\n\n                -p      shortcut of --parameters\n                        The command parameters (comma separated).\n\n                -d      shortcut of --description\n                        The command description.\n\n                -a      shortcut of --aliases\n                        The command aliases (comma separated).\n\n        × Samples :\n                Creates a new custom command\n                  · Ubiquity create-command custom\n\n■ acl-init [] =\u003e\n        · Initialize Acls defined with annotations in controllers.\n        · Aliases : acl_init,acl:init,aclInit\n        × Samples :\n                Initialize Acls\n                  · Ubiquity aclInit\n\n■ acl-display [] =\u003e\n        · Display Acls defined with annotations in controllers.\n        · Aliases : acl_display,acl:display,aclDisplay\n        · Parameters :\n                -v      shortcut of --value\n                        The ACL part to display.\n                        Possibles values :\n                        all,role,resource,permission,map,acl\n                        Default : [acl]\n\n        × Samples :\n                Display all defined roles with ACL annotations\n                  · Ubiquity aclDisplay role\n\n■ new-key [cypher] =\u003e\n        · Generate a new encryption key using a cipher.\n        · Aliases : new_key,new:key,newKey\n        × Samples :\n                Generate a key for AES-128\n                  · Ubiquity new-key 128\n\n■ domain [name] =\u003e\n        · Creates a new domain (for a Domain Driven Design approach).\n        · Aliases : new-domain,new_domain,new:domain,newDomain\n        · Parameters :\n                -b      shortcut of --base\n                        The base folder for domains.\n                        Default : [domains]\n\n        × Samples :\n                Creates a new domain users\n                  · Ubiquity domain users\n```\n\n### Project creation\nOnce installed, the simple `Ubiquity new` command will create a fresh micro installation in the directory you specify. For instance, `Micro new blog` would create a directory named blog containing an Ubiquity project:\n```bash\nUbiquity new blog\n```\nYou can see more options about installation by reading the [Project creation section](http://micro-framework.readthedocs.io/en/latest/install.html).\n\n### Running\nYou can test with the php web server,\nfrom the root folder of your web application, run :\n```\nUbiquity serve\n```\n\n### Models creation\nmake sure that the database is configured properly in app/config/config.php file :\n```bash\nUbiquity config -f=database\n```\n\n![img](https://github.com/phpmv/ubiquity-devtools/blob/master/.github/images/db-conf.png)\n\nExecute the command, make sure you are also in the project folder or one of its subfolders :\n```bash\nUbiquity all-models\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphpmv%2Fubiquity-devtools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fphpmv%2Fubiquity-devtools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphpmv%2Fubiquity-devtools/lists"}