{"id":13746117,"url":"https://github.com/kenjis/codeigniter-cli","last_synced_at":"2025-04-07T13:05:59.849Z","repository":{"id":31161570,"uuid":"34721688","full_name":"kenjis/codeigniter-cli","owner":"kenjis","description":"Cli for CodeIgniter 3.0","archived":false,"fork":false,"pushed_at":"2023-06-02T12:56:48.000Z","size":102,"stargazers_count":95,"open_issues_count":10,"forks_count":20,"subscribers_count":12,"default_branch":"master","last_synced_at":"2024-04-09T14:46:08.286Z","etag":null,"topics":["codeigniter3","hacktoberfest"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kenjis.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2015-04-28T09:34:44.000Z","updated_at":"2024-01-17T15:49:33.000Z","dependencies_parsed_at":"2024-01-15T00:51:19.580Z","dependency_job_id":"6277efe0-f2fc-46ff-af0c-e3ae04da6831","html_url":"https://github.com/kenjis/codeigniter-cli","commit_stats":{"total_commits":120,"total_committers":3,"mean_commits":40.0,"dds":0.06666666666666665,"last_synced_commit":"7c4990eae6a59be26e819841b2853d11fc927fad"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kenjis%2Fcodeigniter-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kenjis%2Fcodeigniter-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kenjis%2Fcodeigniter-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kenjis%2Fcodeigniter-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kenjis","download_url":"https://codeload.github.com/kenjis/codeigniter-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247657276,"owners_count":20974344,"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":["codeigniter3","hacktoberfest"],"created_at":"2024-08-03T06:00:47.236Z","updated_at":"2025-04-07T13:05:59.822Z","avatar_url":"https://github.com/kenjis.png","language":"PHP","readme":"# Cli for CodeIgniter 3.0\n\n[![Latest Stable Version](https://poser.pugx.org/kenjis/codeigniter-cli/v/stable)](https://packagist.org/packages/kenjis/codeigniter-cli) [![Total Downloads](https://poser.pugx.org/kenjis/codeigniter-cli/downloads)](https://packagist.org/packages/kenjis/codeigniter-cli) [![Latest Unstable Version](https://poser.pugx.org/kenjis/codeigniter-cli/v/unstable)](https://packagist.org/packages/kenjis/codeigniter-cli) [![License](https://poser.pugx.org/kenjis/codeigniter-cli/license)](https://packagist.org/packages/kenjis/codeigniter-cli)\n\n[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/kenjis/codeigniter-cli/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/kenjis/codeigniter-cli/?branch=master)\n[![Coverage Status](https://coveralls.io/repos/kenjis/codeigniter-cli/badge.svg?branch=master)](https://coveralls.io/r/kenjis/codeigniter-cli?branch=master)\n[![Build Status](https://travis-ci.org/kenjis/codeigniter-cli.svg?branch=master)](https://travis-ci.org/kenjis/codeigniter-cli)\n\nThis package provides a Cli tool for [CodeIgniter](https://github.com/bcit-ci/CodeIgniter) 3.0.\n\nThis includes a few commands and you can create your commands easily.\n\nThis is based on Aura.Cli_Project 2.0.\n\n## Included Commands\n\n~~~\ngenerate migration ... Generates migration file skeleton.\nmigrate            ... Run migrations.\nmigrate status     ... List all migration files and versions.\nseed               ... Seed the database.\nrun                ... Run controller.\n~~~\n\n## Folder Structure\n\n```\ncodeigniter/\n├── application/\n├── ci_instance.php ... script to generate CodeIgniter instance\n├── cli             ... command file\n├── config/         ... config folder\n└── vendor/\n```\n\n## Requirements\n\n* PHP 5.4.0 or later\n* `composer` command\n* Git\n\n## Installation\n\nInstall this project with Composer:\n\n~~~\n$ cd /path/to/codeigniter/\n$ composer require kenjis/codeigniter-cli --dev\n~~~\n\nInstall command file (`cli`) and config files (`config/`) to your CodeIgniter project:\n\n~~~\n$ php vendor/kenjis/codeigniter-cli/install.php\n~~~\n\n* Above command always overwrites exisiting files.\n* You must run it at CodeIgniter project root folder.\n\nFix the paths in `ci_instance.php` if you need.\n\n~~~php\n$system_path        = 'vendor/codeigniter/framework/system';\n$application_folder = 'application';\n$doc_root           = 'public'; // where index.php is\n~~~\n\nIf you install CodeIgniter using [codeigniter-composer-installer](https://github.com/kenjis/codeigniter-composer-installer), you don't have to change them.\n\n## Usage\n\nShow command list.\n\n~~~\n$ cd /path/to/codeigniter/\n$ php cli\n~~~\n\nShow help for a command.\n\n~~~\n$ php cli help seed\n~~~\n\n## Create Database Seeds\n\nSeeder class must be placed in `application/database/seeds` folder.\n\n`application/database/seeds/ProductSeeder.php`\n~~~php\n\u003c?php\n\nclass ProductSeeder extends Seeder {\n\n\tpublic function run()\n\t{\n\t\t$this-\u003edb-\u003etruncate('product');\n\n\t\t$data = [\n\t\t\t'category_id' =\u003e 1,\n\t\t\t'name' =\u003e 'CodeIgniter Book',\n\t\t\t'detail' =\u003e 'Very good CodeIgniter book.',\n\t\t\t'price' =\u003e 3800,\n\t\t];\n\t\t$this-\u003edb-\u003einsert('product', $data);\n\n\t\t$data = [\n\t\t\t'category_id' =\u003e 2,\n\t\t\t'name' =\u003e 'CodeIgniter CD',\n\t\t\t'detail' =\u003e 'Great CodeIgniter CD.',\n\t\t\t'price' =\u003e 4800,\n\t\t];\n\t\t$this-\u003edb-\u003einsert('product', $data);\n\n\t\t$data = [\n\t\t\t'category_id' =\u003e 3,\n\t\t\t'name' =\u003e 'CodeIgniter DVD',\n\t\t\t'detail' =\u003e 'Awesome CodeIgniter DVD.',\n\t\t\t'price' =\u003e 5800,\n\t\t];\n\t\t$this-\u003edb-\u003einsert('product', $data);\n\t}\n\n}\n~~~\n\n## Create User Command\n\nCommand class name must be `*Command.php` and be placed in `application/commands` folder.\n\n`application/commands/TestCommand.php`\n~~~php\n\u003c?php\n\nclass TestCommand extends Command {\n\n\tpublic function __invoke()\n\t{\n\t\t$this-\u003estdio-\u003eoutln('\u003c\u003cgreen\u003e\u003eThis is TestCommand class\u003c\u003creset\u003e\u003e');\n\t}\n\n}\n~~~\n\nCommand Help class name must be `*CommandHelp.php` and be placed in `application/commands` folder.\n\n`application/commands/TestCommandHelp.php`\n~~~php\n\u003c?php\n\nclass TestCommandHelp extends Help {\n\n\tpublic function init()\n\t{\n\t\t$this-\u003esetSummary('A single-line summary.');\n\t\t$this-\u003esetUsage('\u003carg1\u003e \u003carg2\u003e');\n\t\t$this-\u003esetOptions(array(\n\t\t\t'f,foo' =\u003e \"The -f/--foo option description\",\n\t\t\t'bar::' =\u003e \"The --bar option description\",\n\t\t));\n\t\t$this-\u003esetDescr(\"A multi-line description of the command.\");\n\t}\n\n}\n~~~\n\n### Reference\n\n* https://github.com/auraphp/Aura.Cli_Project\n* http://auraphp.com/framework/2.x/en/cli/\n\n## How to Run Tests\n\nTo run tests, you must install CodeIgniter first.\n\n~~~\n$ composer create-project kenjis/codeigniter-composer-installer codeigniter\n$ cd codeigniter\n$ composer require kenjis/codeigniter-cli:1.0.x@dev --dev\n$ php vendor/kenjis/codeigniter-cli/install.php\n$ cd vendor/kenjis/codeigniter-cli\n$ composer install\n$ phpunit\n~~~\n\n## Related Projects for CodeIgniter 3.0\n\n* [CodeIgniter Composer Installer](https://github.com/kenjis/codeigniter-composer-installer)\n* [CI PHPUnit Test](https://github.com/kenjis/ci-phpunit-test)\n* [CodeIgniter Simple and Secure Twig](https://github.com/kenjis/codeigniter-ss-twig)\n* [CodeIgniter Doctrine](https://github.com/kenjis/codeigniter-doctrine)\n* [CodeIgniter Deployer](https://github.com/kenjis/codeigniter-deployer)\n* [CodeIgniter3 Filename Checker](https://github.com/kenjis/codeigniter3-filename-checker)\n","funding_links":[],"categories":["CLI"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkenjis%2Fcodeigniter-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkenjis%2Fcodeigniter-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkenjis%2Fcodeigniter-cli/lists"}