README

這是為了 LYRASOFT 日常工作與建立設定檔所開發的方便工具。

快速安裝

php -r "copy('https://raw.githubusercontent.com/lyrasoft/lyra-cli/master/resources/installer/lyra-cli-installer.php', 'lyra-cli-installer.php');"
php lyra-cli-installer.php
php -r "unlink('lyra-cli-installer.php');"

一般安裝方式

快速安裝無法正確執行時，請依照以下步驟進行：

composer global require lyrasoft/cli

安裝完成後，可在任何地方直接輸入:

lyra <command>

來執行相關指令。

Mac / Linux 無法執行時

Mac 必須先將 ~/.composer/vendor/bin 加入到 PATH 環境變數

請參考 https://stackoverflow.com/a/25373254

echo 'export PATH="$PATH:$HOME/.composer/vendor/bin"' >> ~/.bash_profile
source ~/.bash_profile

Linux 的路徑比較不一樣

echo 'export PATH="$PATH:$HOME/.config/composer/vendor/bin"' >> ~/.bashrc
source ~/.bashrc

自動完成

只要輸入一次

lyra autocomplete

註冊好自動完成的指令後，之後就可以用 Tab 自動完成指令了

只支援 zsh

常用功能說明

更新 PhpStorm 設定檔

我們的常用設定檔有三組，分別是 CodeStyle, FileTemplate 與 LiveTemplate

可以用：

lyra pstorm:pull-config -a -g

來更新 PhpStorm 的全域設定檔。也可以用：

lyra pstorm:pull-config -a

單純只更新到現在的專案

如果你要把自己設定好的設定檔更新到我們得 repository 給其他人分享，可以用：

lyra pstorm:push-config -a

注意這個動作不要隨便進行

Get PR

現在可以透過 lyra cli 快速取用 PR 來測試，取代以前的 get-pr 指令

lyra pr {number}

預設會拉下來成 pr-xxx 的 branch，也可以指定特定的 branch：

lyra pr {number} branch_name

拉下後直接切換

lyra pr {number} -c

預設是從 lyra 的 remote 取用 PR，請按照命名原則設定你的 git remote，也可以自定 remote

lyra pr {number} -r=upstream

PHP Code Sniffer

先切換到專案目錄(確定已經先用 phpstorm 開啟過這個目錄，有 .idea 資料夾)，第一次先執行：

lyra pstorm sniffer -p

就會自動設定好我們的 Sniffer 設定檔，並下載我們的 Code Style 規則。第二次之後可以省略 -p 直接啟用 phpstorm 的 sniffer 功能。

lyra pstorm:sniffer

如果未來我們的 Sniffer 規則有更動，只要再執行第一個指令或者再任何地方執行：

lyra sniffer:sync

就會自動刷新 Sniffer 規則

註冊 GitHub SSH Key

lyra-cli 提供了方便的指令直接幫你註冊 GitHub SSH Key.

執行

lyra github:add-ssh

第一次會需要產生 SSH Key

Your identification has been saved in C:\Users\Xxx/.ssh/id_rsa.
Your public key has been saved in C:\Users\Xxx/.ssh/id_rsa.pub.
The key fingerprint is:
SHA256:cT7l5fe4kzlKsxQle1jC6/0p4je**********
The key's randomart image is:
+---[RSA 4096]----+
|                 |
|           .     |
|        . . = +  |
|         + o @ o |
|        S o * B .|
|           o *.=.|
|          o E.=+.|
|         . @.O==+|
|         .+oB.*=+|
+----[SHA256]-----+

SSH Key 產生之後，會問你 GitHub 的登入帳密，輸入後便可自動註冊完成。

完整指令說明

請直接用 -h 觀看說明

開發方式

若要增加或修改功能，可以用 composer global require lyrasoft/cli --prefer-source ，這樣就會下載 github 上的版本，就可以直接編輯，然後用 git commit 修改內容。記得可以先 fork 一份，然後加上你自己的 remote。

編輯位置在 Composer 的 global 目錄:

Windows: C:\Users\<user_name>\AppData\Roaming\Composer
Mac: ~/.composer

lyra-cli 的目錄在 {COMPOSER_HOME}/vendor/lyrasoft/cli 內。

Command 的編寫方式

最上層 Command 請寫好 class 之後，註冊在 /lyra 檔案內。

See:

lyra-cli/lyra

Line 34 in 6c76cac

$app->addCommand(Command\PstormCommand::class);

之後的寫法請參考: Windwalker Console

lyrasoft / cli

Maintainers

Details