PHPackages                             varavan/hints - 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. varavan/hints

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

varavan/hints
=============

Knowledge sharing made easy

v1.1(9y ago)2127PHP

Since Oct 31Pushed 9y ago1 watchersCompare

[ Source](https://github.com/varavan/hints)[ Packagist](https://packagist.org/packages/varavan/hints)[ RSS](/packages/varavan-hints/feed)WikiDiscussions master Synced 3w ago

READMEChangelogDependencies (5)Versions (15)Used By (0)

Hints
=====

[](#hints)

Microlearning tool for sharing knowledge on php projects, no mather how complex is the project. Have you ever found yourself trying to fix something for ages, then someone else tell you an small hint that makes you resolve it within minutes? That is the purpose for of this project. To have a set of hints that can be easily add or shown from your terminal.

Example
-------

[](#example)

**show random hint**[![show random hint](https://camo.githubusercontent.com/713ab8f67f2bd7cfd842543de504e305d20ae315ed4eb53aa615254f1f82478d/687474703a2f2f696d616765736861636b2e636f6d2f612f696d673932312f373034312f46363856336a2e706e67 "Show random hint")](https://camo.githubusercontent.com/713ab8f67f2bd7cfd842543de504e305d20ae315ed4eb53aa615254f1f82478d/687474703a2f2f696d616765736861636b2e636f6d2f612f696d673932312f373034312f46363856336a2e706e67)

**show hint related to some code**[![show hint related to some code](https://camo.githubusercontent.com/f49cd721f4ba1b91209bf0cc7fb55604a85a5809772715f54af648e81e8eeea5/687474703a2f2f696d616765736861636b2e636f6d2f612f696d673932322f393535342f6c4461566d692e706e67 "show hint related to some code")](https://camo.githubusercontent.com/f49cd721f4ba1b91209bf0cc7fb55604a85a5809772715f54af648e81e8eeea5/687474703a2f2f696d616765736861636b2e636f6d2f612f696d673932322f393535342f6c4461566d692e706e67)

**adding a new hint**[![adding new hints](https://camo.githubusercontent.com/47cbf63b9e7f6115968996afbe871f4f7e342eec9ca3cac09d7784e4801b7078/687474703a2f2f696d616765736861636b2e636f6d2f612f696d673932322f363234342f7a5a795639442e706e67 "adding new hints")](https://camo.githubusercontent.com/47cbf63b9e7f6115968996afbe871f4f7e342eec9ca3cac09d7784e4801b7078/687474703a2f2f696d616765736861636b2e636f6d2f612f696d673932322f363234342f7a5a795639442e706e67)

Installation
------------

[](#installation)

Install it via composer with `composer require varavan/hints`

Usage
-----

[](#usage)

There is an entry point for the application which is the file `hints`. After the installation you can call it via `vendor/varavan/hints/hints` As long as this project is thought to be implemented on php projects, the app is written on php.

I would encourage you to create a symlink between the executable file `hints` and your `bin` folder. So it is easier to include `hints` on your project

I would advice you to call `hints` command on `composer` `post-scripts`, so everyone can refresh thoose knowleage pills on every vendor updates

Please notice that the storage for this application is a file called `hints.json` that will be versioned

**adding hints**`hints add 'content of the hint'`

- option to add some author metadata --author 'AUTHOR NAME'
- option to add some tags as metadata --tags 'ADD TAGS SEPARATE BY COMMA'
- option to point a file --file-path 'FILE\_PATH\_FOR\_CONTENT\_RELATED'
- option to point a line --file-line 'FILE\_LINE'

**listing hints**`hints show`

- option to filter by tags --tags 'tag'
- option to filter by author --author
- option to filter by file --file-path
- option to set up a limit (by default 1) --limit

For example `hints show --author 'Jhon Doe' --tags 'set-up,init' --limit 15`

Status
------

[](#status)

This library is still on development. You can find some bugs and errors on it. Please report it :)

###  Health Score

31

—

LowBetter than 66% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity13

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity71

Established project with proven stability

 Bus Factor1

Top contributor holds 100% 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 ~3 days

Total

14

Last Release

3480d ago

Major Versions

v0.10.2 → v1.02016-12-08

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/761880?v=4)[Ivan Ruiz](/maintainers/varavan)[@varavan](https://github.com/varavan)

---

Top Contributors

[![varavan](https://avatars.githubusercontent.com/u/761880?v=4)](https://github.com/varavan "varavan (22 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/varavan-hints/health.svg)

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

###  Alternatives

[friendsoftypo3/content-blocks

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

101466.4k45](/packages/friendsoftypo3-content-blocks)[aeliot/todo-registrar

Register TODOs from source code in issue tracker

153.0k](/packages/aeliot-todo-registrar)

PHPackages © 2026

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