PHPackages                             petehouston/xin-artisan - 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. [CLI &amp; Console](/categories/cli)
4. /
5. petehouston/xin-artisan

ActiveLibrary[CLI &amp; Console](/categories/cli)

petehouston/xin-artisan
=======================

the "xin" command for Laravel artisan.

1.2.0(10y ago)415MITPHP ~5.5|~7.0

Since Jun 3Compare

[ Source](https://github.com/petehouston/xin-artisan)[ Packagist](https://packagist.org/packages/petehouston/xin-artisan)[ Docs](https://github.com/petehouston/xin-artisan)[ RSS](/packages/petehouston-xin-artisan/feed)WikiDiscussions Synced 2w ago

READMEChangelogDependencies (3)Versions (4)Used By (0)

Xin for Artisan command
=======================

[](#xin-for-artisan-command)

[![Latest Version on Packagist](https://camo.githubusercontent.com/46d18cdb0bb8aaadb7322c4a5d0f2872de186398f18ad06579b4c177879e0c29/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f70657465686f7573746f6e2f78696e2d6172746973616e2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/petehouston/xin-artisan)[![Software License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE.md)

[![Xin Logo](xin-logo.png)](xin-logo.png)

**Xin**, *in Vietnamese*, is to "ask for something on demand". Now, you can **xin** something right into Laravel Artisan console.

Install
-------

[](#install)

Via Composer

```
$ composer require petehouston/xin-artisan
```

### Setup

[](#setup)

Append this line to `$providers` variable on `config/app.php` file:

```
    'providers' => [
        ...
        Petehouston\Xin\XinServiceProvider::class,
    ]

```

### Configuration

[](#configuration)

You need to add xin config file `xin.php` to your project:

```
$ php artisan vendor:publish --provider="Petehouston\Xin\XinServiceProvider" --tag=config

```

**Some config variables for use:**

- `browser.bin`: the absolute path to the browser binary you want to use. Default, xin will automatically look up for you.

Command list
------------

[](#command-list)

Following commands are supported:

- [xin:ip](#ask-for-ip-address): get IP address.
- [xin:docs](#open-a-laravel-documentation-section): read Laravel documentation.
- [xin:log](#play-with-log-files): play around with log files.
- [xin:gist](#share-code-via-gist): Share code via public Gist.
- [xin:view](#create-empty-blade-view): create empty Blade view.

Usage
-----

[](#usage)

### Ask for IP address

[](#ask-for-ip-address)

**Get local IP address:**

```
$ php artisan xin:ip
Local IP address is: 192.168.100.3

```

**Get public/external IP address:**

```
$ php artisan xin:ip --public
External IP address is: 13.66.202.129

```

### Open a Laravel documentation section

[](#open-a-laravel-documentation-section)

**List all available Laravel documentation sections:**

```
$ php artisan xin:docs list

All of Laravel documentation sections are listed below:
+----------------------------+-------------------------+
| Section                    | Key                     |
+----------------------------+-------------------------+
| Release Notes              | releases                |
| Upgrade Guide              | upgrade                 |
| Contribution Guide         | contributions           |
| Installation               | installation            |
| Configuration              | configuration           |
| Homestead                  | homestead               |
| Valet                      | valet                   |
| Basic Task List            | quickstart              |
| Intermediate Task List     | quickstart-intermediate |
| Routing                    | routing                 |
| Middleware                 | middleware              |
| Controllers                | controllers             |
| Requests                   | requests                |
| Responses                  | responses               |
| Views                      | views                   |
| Blade Templates            | blade                   |
| Request Lifecycle          | lifecycle               |
| Application Structure      | structure               |
| Service Providers          | providers               |
| Service Container          | container               |
| Contracts                  | contracts               |
| Facades                    | facades                 |
| Authentication             | authentication          |
| Authorization              | authorization           |
| Artisan Console            | artisan                 |
| Billing                    | billing                 |
| Cache                      | cache                   |
| Collections                | collections             |
| Elixir                     | elixir                  |
| Encryption                 | encryption              |
| Errors & Loggin            | errors                  |
| Events                     | events                  |
| Filesystem & Cloud Storage | filesystem              |
| Hashing                    | hashing                 |
| Helpers                    | helpers                 |
| Localization               | localization            |
| Mail                       | mail                    |
| Package Development        | packages                |
| Pagination                 | pagination              |
| Queues                     | queues                  |
| Redis                      | redis                   |
| Session                    | session                 |
| SSH Tasks                  | envoy                   |
| Task Scheduling            | scheduling              |
| Testing                    | testing                 |
| Validation                 | validation              |
| Database - Getting Started | database                |
| Query Builder              | queries                 |
| Migrations                 | migrations              |
| seeding                    | seeding                 |
| Eloquent - Getting Started | eloquent                |
| Relationships              | eloquent-relationships  |
| Eloquent Collections       | eloquent-collections    |
| Mutators                   | eloquent-mutators       |
| Eloquent Serialization     | eloquent-serialization  |
+----------------------------+-------------------------+

```

**Open the section on browser:**

Xin will use the default system browser to open URL. Key is the value available from "list".

```
$ php artisan xin:docs read --key=envoy

```

**Open documentation in different languages:**

Use `--locale` option. Currently, only "en" and "vn" are supported. Default is "en".

```
$ php artisan xin:docs read --key=structure --locale=vn

```

### Play with log files

[](#play-with-log-files)

All logs are stored under `storage/logs` directory.

**Read log file**

The default log file is `laravel.log`.

```
$ php artisan xin:log

```

You can read content of different log files by name:

```
$ php artisan xin:log --name=custom.log

```

**Clean log file content**

```
$ php artisan xin:log --clean

```

The log file will be empty.

You can combine clean a custom log file:

```
$ php artisan xin:log --name=custom.log --clean

```

**Remove all logs**

```
$ php artisan xin:log --remove-all

```

This command will remove all files in `storage/logs` directory.

### Share code via Gist

[](#share-code-via-gist)

This command will share a source file to public Gist. It will response with **Gist Id** and **Gist Url**.

```
$ php artisan xin:gist [filename] --desc="Sharing description."

```

For example, if you want to share `public/index.php` file:

```
$ php artisan xin:gist public/index.php --desc="Sharing Laravel index file."
Gist Sharing Information
------------------------------------------------------------------
Gist Id:  37c55c18cd63c34195c22fafbff6fe16
Gist Url: https://gist.github.com/37c55c18cd63c34195c22fafbff6fe16

```

**Note:** on Windows, since the path separator is `\`, so you need to wrap the `filename` with double-quotation mark `"` like this:

```
$ php artisan xin:gist "public\index.php"

```

### Create empty Blade view

[](#create-empty-blade-view)

Wanna create Blade view file from command quickly? Use this:

```
$ php artisan xin:view admin.auth.login

```

It will create `login.blade.php` at `resources/views/admin/auth`, it also does create any directory that doesn't exist in the path.

Apparently, in Linux/Unix/Mac, you can use `touch`.

```
$ mkdir resources/views/admin/auth
$ touch resources/views/admin/auth/login.blade.php

```

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

###  Health Score

27

—

LowBetter than 46% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity10

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity60

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 ~0 days

Total

3

Last Release

3723d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/e3bd650ae2924847027ca5ff3cd7d1c0dd2d5f87bbb5e218bd273a32928e727e?d=identicon)[petehouston](/maintainers/petehouston)

---

Top Contributors

[![petehouston](https://avatars.githubusercontent.com/u/9006720?v=4)](https://github.com/petehouston "petehouston (14 commits)")

---

Tags

phpartisanlaravel 5xinxin-artisan

### Embed Badge

![Health badge](/badges/petehouston-xin-artisan/health.svg)

```
[![Health](https://phpackages.com/badges/petehouston-xin-artisan/health.svg)](https://phpackages.com/packages/petehouston-xin-artisan)
```

###  Alternatives

[laravel/boost

Laravel Boost accelerates AI-assisted development by providing the essential context and structure that AI needs to generate high-quality, Laravel-specific code.

3.6k26.0M785](/packages/laravel-boost)[spatie/laravel-health

Monitor the health of a Laravel application

88212.7M185](/packages/spatie-laravel-health)[craftcms/cms

Craft CMS

3.6k3.7M3.4k](/packages/craftcms-cms)[laravel/ai

The official AI SDK for Laravel.

1.1k4.6M306](/packages/laravel-ai)[spatie/laravel-export

Create a static site bundle from a Laravel app

679153.2k7](/packages/spatie-laravel-export)[tallstackui/tallstackui

TallStackUI is a powerful suite of Blade components that elevate your workflow of Livewire applications.

731189.9k16](/packages/tallstackui-tallstackui)

PHPackages © 2026

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