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

注意这个操作不要随便进行

获取PR

现在可以通过lyra cli快速获取PR进行测试，取代以前的get-pr指令

lyra pr {number}

默认会拉下成pr-xxx的分支，也可以指定特定的分支：

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的全局目录

• 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

第34行在6c76cac

之后的写法请参考：Windwalker Console