PHPackages                             mkusher/padawan - 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. mkusher/padawan

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

mkusher/padawan
===============

Smart php completion server

v0.2.1(10y ago)2547.2k29[25 issues](https://github.com/mkusher/padawan.php/issues)[4 PRs](https://github.com/mkusher/padawan.php/pulls)MITPHP

Since May 9Pushed 8y ago17 watchersCompare

[ Source](https://github.com/mkusher/padawan.php)[ Packagist](https://packagist.org/packages/mkusher/padawan)[ RSS](/packages/mkusher-padawan/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (4)Dependencies (13)Versions (8)Used By (0)

Padawan.php smart php intelligent code completion for php projects
==================================================================

[](#padawanphp-smart-php-intelligent-code-completion-for-php-projects)

[![Join the chat at https://gitter.im/mkusher/padawan.php](https://camo.githubusercontent.com/abe08b740a4156153736f791393ec4da6619c4be73212e75769f52edacc0e2b5/68747470733a2f2f6261646765732e6769747465722e696d2f4a6f696e253230436861742e737667)](https://gitter.im/mkusher/padawan.php?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![Build Status](https://camo.githubusercontent.com/e39a2d55a32874e2c9a5cd96afdec556fd7308ce755d4117770cfcddf5abca4e/68747470733a2f2f7472617669732d63692e6f72672f7061646177616e2d7068702f7061646177616e2e7068702e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/padawan-php/padawan.php)[![Total Downloads](https://camo.githubusercontent.com/2004557501c8317e3852da5d826ad7cf8a748d07f4dd73c56baea2095a3e199d/68747470733a2f2f706f7365722e707567782e6f72672f6d6b75736865722f7061646177616e2f646f776e6c6f616473)](https://packagist.org/packages/mkusher/padawan)[![Latest Stable Version](https://camo.githubusercontent.com/c9d2e049e8cf392c2beb192337b16051829b3c7e421c9e077e749a14943e90a0/68747470733a2f2f706f7365722e707567782e6f72672f6d6b75736865722f7061646177616e2f762f737461626c65)](https://packagist.org/packages/mkusher/padawan)[![Latest Unstable Version](https://camo.githubusercontent.com/13f53c28c8db850abe630149efe9492408247804b482f06a3c6da792b09ca43e/68747470733a2f2f706f7365722e707567782e6f72672f6d6b75736865722f7061646177616e2f762f756e737461626c65)](https://packagist.org/packages/mkusher/padawan)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/a490a2229b2fd2460578aa0b1f69077ae50cbbe48c74004cd45ff7c1c8bec4e0/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f7061646177616e2d7068702f7061646177616e2e7068702f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/padawan-php/padawan.php/?branch=master)[![License](https://camo.githubusercontent.com/f150f9dbde602e9a9ab05e216726806f4d1bbef8ee4bf699fe0bde0f8cf48980/68747470733a2f2f706f7365722e707567782e6f72672f6d6b75736865722f7061646177616e2f6c6963656e7365)](https://packagist.org/packages/mkusher/padawan)

***Looking for maintainers! Please join gitter channel for discussion***

Padawan.php is an http server that parses your project and gives you completions. Padawan.php looks recursively for all php files of a composer project, parses doc-comments and function declarations of each class and creates an index from them. After that it autoupdates the index and gives you completion as you type.

Padawan.php can be extended by various plugins, which will bring some extra completion, framework integrations or so. [See this paragraph to learn more](https://github.com/mkusher/padawan.php#pluginsextensions-for-padawanphp)

It tries to be a [Jedi](https://github.com/davidhalter/jedi), but currently it's only a padawan :)

Plugins for editors
-------------------

[](#plugins-for-editors)

1. [Vim](https://github.com/mkusher/padawan.vim)
2. [Neovim](https://github.com/pbogut/deoplete-padawan)
3. Sublime Text: [Padawan for ST3](https://github.com/mkusher/padawan.sublime) and [SublimePHPCompanion](https://github.com/erichard/SublimePHPCompanion)

If you wish to write your own plugin, vim plugin example may serve as a source of inspiration. Look at [wiki page](https://github.com/mkusher/padawan.php/wiki/Editors'-plugins) for some documentation. You are welcome to open an issue if you have any questions.

### Demo videos

[](#demo-videos)

Watch this short videos to see what it can already do(image is clickable) [![ScreenShot](https://camo.githubusercontent.com/6a60b3540450f22beb6c9af874fffe118e0ed50926a80c97aeda43516cc08b1a/687474703a2f2f69312e7974696d672e636f6d2f76692f71704c4a443234445963552f6d617872657364656661756c742e6a7067)](https://www.youtube.com/watch?v=qpLJD24DYcU)[![ScreenShot](https://camo.githubusercontent.com/3251701c509411fcb2467e765808799470330e29b8ccb9bc5da5c05f6bed2604/687474703a2f2f69312e7974696d672e636f6d2f76692f59353450324e3154362d492f6d617872657364656661756c742e6a7067)](https://www.youtube.com/watch?v=Y54P2N1T6-I)

How to use
==========

[](#how-to-use)

- Install padawan.php through `composer`:

```
$ composer global require mkusher/padawan
```

- Add [composer global bin to your $PATH](https://getcomposer.org/doc/03-cli.md#global):

```
PATH=$PATH:$HOME/.composer/vendor/bin
```

- Install plugin for your editor.
- Run index generation command in your php composer project folder:

```
padawan generate
```

- Start padawan's server

```
padawan-server
```

- Enjoy smart completion

Check out how to do this in the plugin documentation for specific editor above.

Plugins(extensions) for padawan.php
-----------------------------------

[](#pluginsextensions-for-padawanphp)

Padawan.php can be extended by plugins, there are:

- Symfony2 plugin
- PHP-DI plugin

Look at [full plugins list](https://github.com/mkusher/padawan.php/wiki/Plugins-list)

Why not the original plugin
---------------------------

[](#why-not-the-original-plugin)

This project was inspired by [phpcomplete-extended by M2mdas](https://github.com/m2mdas/phpcomplete-extended)and started as a fork with a completely rewritten index generation part. But as of now it is a completely new project with different design principles

M2mdas's plugin is pretty good, but has some core bugs due to self-written parser:

- It does not support files with 2 or more classes in it
- It fails on parsing RabbitMQ classes and many others
- So it has some design faults and needs a global plugin redesign
- It is ill-suited for adding assignment parsing
- It is vim-only and is written in VimScript

So, I decided to create my own project.

Note
----

[](#note)

Install `igbinary` PHP extension to get optimized index file size and load speed.

Roadmap
-------

[](#roadmap)

Now in progress:

- Implement `go to definition`, `go to assingment`, `show documentation`
- Add plugins for editors(emacs, atom and etc.)
- Extend type guessing(process classes' contructors, class doc-comment, foreach loops)
- Implement index updating

License
-------

[](#license)

MIT licensed.

Acknowledgements
----------------

[](#acknowledgements)

This plugin would not have been possible without the works of [Nikita Popov](https://github.com/nikic) on his amazing PHP-Parser, [React team](https://github.com/reactphp) on their http server, [M2mdas](https://github.com/m2mdas), [Dave Halter](https://github.com/davidhalter)and many others.

###  Health Score

36

—

LowBetter than 82% of packages

Maintenance18

Infrequent updates — may be unmaintained

Popularity37

Limited adoption so far

Community23

Small or concentrated contributor base

Maturity58

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 76.7% 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 ~41 days

Total

4

Last Release

3904d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/7b78590e78b5939d3aed84a03353502005af4d8377f055383ca2bd5ccc987c18?d=identicon)[mkusher](/maintainers/mkusher)

---

Top Contributors

[![mkusher](https://avatars.githubusercontent.com/u/523021?v=4)](https://github.com/mkusher "mkusher (174 commits)")[![chitoku-k](https://avatars.githubusercontent.com/u/6535425?v=4)](https://github.com/chitoku-k "chitoku-k (30 commits)")[![halftan](https://avatars.githubusercontent.com/u/1898104?v=4)](https://github.com/halftan "halftan (15 commits)")[![kokx](https://avatars.githubusercontent.com/u/138556?v=4)](https://github.com/kokx "kokx (3 commits)")[![m2mdas](https://avatars.githubusercontent.com/u/1096944?v=4)](https://github.com/m2mdas "m2mdas (3 commits)")[![gitter-badger](https://avatars.githubusercontent.com/u/8518239?v=4)](https://github.com/gitter-badger "gitter-badger (1 commits)")[![scrutinizer-auto-fixer](https://avatars.githubusercontent.com/u/6253494?v=4)](https://github.com/scrutinizer-auto-fixer "scrutinizer-auto-fixer (1 commits)")

###  Code Quality

TestsBehat

### Embed Badge

![Health badge](/badges/mkusher-padawan/health.svg)

```
[![Health](https://phpackages.com/badges/mkusher-padawan/health.svg)](https://phpackages.com/packages/mkusher-padawan)
```

###  Alternatives

[prestashop/prestashop

PrestaShop is an Open Source e-commerce platform, committed to providing the best shopping cart experience for both merchants and customers.

9.0k15.4k](/packages/prestashop-prestashop)[silverstripe/framework

The SilverStripe framework

7213.5M2.5k](/packages/silverstripe-framework)[contao/core-bundle

Contao Open Source CMS

1231.6M2.4k](/packages/contao-core-bundle)[symfony/ai-platform

PHP library for interacting with AI platform provider.

51927.7k136](/packages/symfony-ai-platform)[ec-cube/ec-cube

EC-CUBE EC open platform.

78527.0k1](/packages/ec-cube-ec-cube)[flarum/core

Delightfully simple forum software.

211.3M1.9k](/packages/flarum-core)

PHPackages © 2026

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