PHPackages                             haemanthus/codeigniter3-ide-helper - 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. [Utility &amp; Helpers](/categories/utility)
4. /
5. haemanthus/codeigniter3-ide-helper

ActiveLibrary[Utility &amp; Helpers](/categories/utility)

haemanthus/codeigniter3-ide-helper
==================================

CodeIgniter 3 IDE helper generator

v1.0.8(4y ago)4561↓72.2%3[3 PRs](https://github.com/yusuftaufiq/codeigniter3-ide-helper/pulls)MITPHPPHP &gt;=7.4

Since Jun 9Pushed 1y ago1 watchersCompare

[ Source](https://github.com/yusuftaufiq/codeigniter3-ide-helper)[ Packagist](https://packagist.org/packages/haemanthus/codeigniter3-ide-helper)[ Docs](https://github.com/yusuftaufiq/codeigniter3-ide-helper)[ RSS](/packages/haemanthus-codeigniter3-ide-helper/feed)WikiDiscussions main Synced 3w ago

READMEChangelog (9)Dependencies (13)Versions (10)Used By (0)

 [![](https://raw.githubusercontent.com/yusuftaufiq/codeigniter3-ide-helper/main/images/ci3-ide-helper-logo.svg)](https://github.com/yusuftaufiq/codeigniter3-ide-helper)
=========================================================================================================================================================================

[](#--)

 [ ![Lint Codebase Workflow Status](https://camo.githubusercontent.com/5928e13c2be483309735adb9850373e0378ad4fac90fd261a4895808e5000317/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f79757375667461756669712f636f646569676e69746572332d6964652d68656c7065722f6c696e742e796d6c3f6272616e63683d6d61696e266c6162656c3d6c696e74266c6f676f3d676974687562267374796c653d666c61742d737175617265) ](https://github.com/yusuftaufiq/codeigniter3-ide-helper/actions/workflows/lint.yml) [ ![Test Workflow Status](https://camo.githubusercontent.com/e62ce126d9c97ac90291fdbaa439ce315fdcba0dab8633bb9e47e5d57a54821a/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f79757375667461756669712f636f646569676e69746572332d6964652d68656c7065722f746573742e796d6c3f6272616e63683d6d61696e266c6162656c3d74657374266c6f676f3d676974687562267374796c653d666c61742d737175617265) ](https://github.com/yusuftaufiq/codeigniter3-ide-helper/actions/workflows/test.yml) [ ![Code Coverage](https://camo.githubusercontent.com/7d82cbd3137143b753d900a6cc6bcc767ef27f3990970ccf4217ebdeb25e4535/68747470733a2f2f696d672e736869656c64732e696f2f636f6465636f762f632f6769746875622f79757375667461756669712f636f646569676e69746572332d6964652d68656c7065723f6c6f676f3d636f6465636f76267374796c653d666c61742d737175617265) ](https://codecov.io/gh/yusuftaufiq/codeigniter3-ide-helper) [ ![Packagist Version](https://camo.githubusercontent.com/3565d5bd05ff60049955bc4d0b57c5465fa967e81f7a477cdcbf8721bb961a42/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6861656d616e746875732f636f646569676e69746572332d6964652d68656c7065723f6c6f676f3d7061636b6167697374267374796c653d666c61742d737175617265) ](https://packagist.org/packages/haemanthus/codeigniter3-ide-helper) [ ![Docker Image Version (latest semver)](https://camo.githubusercontent.com/bcce5197c93f3bb24604713c7f1710e7aef94435c58ffa67719fd74ae2846473/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f762f6861656d616e746875732f636f646569676e69746572332d6964652d68656c7065723f6c6f676f3d646f636b6572266c6162656c3d646f636b657225323068756226736f72743d73656d766572267374796c653d666c61742d737175617265) ](https://hub.docker.com/repository/docker/haemanthus/codeigniter3-ide-helper)[ ![License](https://camo.githubusercontent.com/77b055095c6906ea2fcbd820217522661de54169fd90909c568d87ebf389df65/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f79757375667461756669712f636f646569676e69746572332d6964652d68656c7065723f7374796c653d666c61742d737175617265) ](https://github.com/yusuftaufiq/codeigniter3-ide-helper/blob/main/LICENSE)

About CodeIgniter 3 IDE Helper
------------------------------

[](#about-codeigniter-3-ide-helper)

CodeIgniter 3 IDE Helper is a CLI application for generating a helper file to provide automatic code completion for your IDE.

IDE helper output is generated based on all the libraries and models you loaded in the [`config/autoload.php`](https://github.com/bcit-ci/CodeIgniter/blob/master/application/config/autoload.php), [`core`](https://github.com/bcit-ci/CodeIgniter/blob/master/application/core), [`controllers`](https://github.com/bcit-ci/CodeIgniter/blob/master/application/controllers), and [`models`](https://github.com/bcit-ci/CodeIgniter/blob/master/application/models) folders.

Usage
-----

[](#usage)

### Via Composer

[](#via-composer)

Installation via Composer (require PHP &gt;= 7.4)

- First, install with `composer require haemanthus/codeigniter3-ide-helper --dev`
- Then, you can use it with `./vendor/bin/ide-helper generate`

### Via Docker

[](#via-docker)

Alternatively, you can install this package via Docker if for whatever reason you don't have and can't install PHP &gt;= 7.4.

- Pull latest Docker image with `docker pull haemanthus/codeigniter3-ide-helper`
- Then, you can use it with `docker run -it --rm -v "$(pwd):/app" haemanthus/codeigniter3-ide-helper generate`

Usage Example
-------------

[](#usage-example)

 [![](https://raw.githubusercontent.com/yusuftaufiq/codeigniter3-ide-helper/main/images/ci3-ide-helper-usage.gif)](https://raw.githubusercontent.com/yusuftaufiq/codeigniter3-ide-helper/main/images/ci3-ide-helper-usage.gif)

Options
-------

[](#options)

CommandsOptionsDescriptionExample./vendor/bin/ide-helper generate`--dir`Set CodeIgniter 3 root directory \[default: `./`\].-`--pattern`Add pattern in string or regex to match files (multiple values allowed).`--pattern '/Controller\b/'` (Match all files with 'Controller' suffix)`--pattern User --pattern Auth` (Match all files with filename containing 'User' or 'Auth')`--output-path`Output path of generated file \[default: `_ide_helper.php`\]`--output-path ./application/_my_ide_helper.php``--help`Display help.-`--quiet`Do not output any message.-`--version`Display application version.-`--no-interaction`Do not ask any interactive question.-Contributing
------------

[](#contributing)

Feel free to contribute, but as this repository release cycle is fully automated using [GitHub Actions Workflows](./.github/workflows/) &amp; [Semantic Release](https://github.com/semantic-release/semantic-release), so make sure your commit messages follow [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0/).

Features for Contributors
-------------------------

[](#features-for-contributors)

- Interactive commit with [Commitizen](https://github.com/commitizen/cz-cli).

    Once you are done making your changes, you can run `npx cz` to bring up a prompt which needs to be filled in according to the [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0/).
- Print debugging with [Symfony Var Dumper](https://symfony.com/doc/current/components/var_dumper.html).

    Debugging CLI applications is very difficult, especially when you are dealing with complex data structures. So to minimize this problem, you can also do print debugging where the results of something you print appear in the browser.

    - First, you can run `composer dumper:start`
    - Open a new terminal then run `composer dumper:serve`
    - Then anywhere inside [`src`](./src/) folder (except [`Application.php`](./src/Application.php), [`Commands/GenerateHelperCommand.php`](./src/Commands/GenerateHelperCommand.php) &amp; [`Providers/AppServiceProvider.php`](./src/Providers/AppServiceProvider.php) files), you can write `dump($something)` or `dd($something)`
    - See the result by opening  in your browser
- Developing inside a Container with [Visual Studio Code Remote Container](https://code.visualstudio.com/docs/remote/containers).

    If you want to develop or explore the source code in this repository further, but you are lazy to install PHP, Composer, Node.js, and various other dependencies. You can also use VS Code Remote Container, just make sure you have Docker &amp; VS Code with [Remote Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) installed.

License
-------

[](#license)

This application is licensed under the [MIT license](http://opensource.org/licenses/MIT).

###  Health Score

31

—

LowBetter than 66% of packages

Maintenance26

Infrequent updates — may be unmaintained

Popularity22

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity54

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 95.4% 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 ~0 days

Total

9

Last Release

1474d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/63e1e83553f8dd73eeabd18cb66fea26e51cbe7aa6d7ea62f1c2c9fa87d19839?d=identicon)[yusuftaufiq](/maintainers/yusuftaufiq)

---

Top Contributors

[![yusuftaufiq](https://avatars.githubusercontent.com/u/52187958?v=4)](https://github.com/yusuftaufiq "yusuftaufiq (187 commits)")[![semantic-release-bot](https://avatars.githubusercontent.com/u/32174276?v=4)](https://github.com/semantic-release-bot "semantic-release-bot (9 commits)")

---

Tags

autocompletioncli-appcodeigniter3ide-helperphp

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Code StylePHP\_CodeSniffer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/haemanthus-codeigniter3-ide-helper/health.svg)

```
[![Health](https://phpackages.com/badges/haemanthus-codeigniter3-ide-helper/health.svg)](https://phpackages.com/packages/haemanthus-codeigniter3-ide-helper)
```

###  Alternatives

[symfony/framework-bundle

Provides a tight integration between Symfony components and the Symfony full-stack framework

3.6k246.0M11.1k](/packages/symfony-framework-bundle)[friendsoftypo3/content-blocks

TYPO3 CMS Content Blocks - Content Types API | Define reusable components via YAML

101466.4k45](/packages/friendsoftypo3-content-blocks)[tempest/framework

The PHP framework that gets out of your way.

2.2k31.1k12](/packages/tempest-framework)[drupal-code-builder/drupal-code-builder

Code generator for Drupal

27249.5k1](/packages/drupal-code-builder-drupal-code-builder)[civicrm/civicrm-core

Open source constituent relationship management for non-profits, NGOs and advocacy organizations.

749284.3k35](/packages/civicrm-civicrm-core)[jolicode/castor

A lightweight and modern task runner. Automate everything. In PHP.

54642.4k4](/packages/jolicode-castor)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
