vierbergenlars / clic
Requires
- justinrainbow/json-schema: ^2.0
- padraic/phar-updater: ^1.0
- symfony/console: ^3.1
- symfony/finder: ^3.1
- symfony/process: ^3.1
README
友好的PHP应用程序部署和设置。
clic
跟踪应用程序及其配置参数,帮助设置私有Git仓库的部署密钥,并通过将应用程序链接到公开可访问的位置来帮助发布应用程序。
许可证
clic
在MIT许可证的条款下发布。
查看license.md文件以获取许可证的完整副本。
安装
选项1:作为phar文件(使用phar-composer)
安装clic
的首选方式是使用phar-composer
工具。您首先需要安装phar-composer。这是一个非常有用的工具,允许您从Composer包创建可运行的phar文件。
如果您已安装phar-composer,您可以运行
sudo phar-composer install vierbergenlars/clic
以使其构建并安装phar文件到您的$PATH
,这将允许您从命令行运行它作为clic
。
或者您可以运行
phar-composer build vierbergenlars/clic
并将生成的phar文件手动复制到您想要的位置。
选项2:作为phar文件(下载)
如果您不想安装phar-composer,您可以从最新版本下载clic.phar
文件。
别忘了使用chmod +x clic.phar
使文件可执行,并将其移动到您的$PATH
中的某个位置。
选项3:作为全局composer安装
clic
可以用composer安装。
composer global require vierbergenlars/clic
您可以使用此方法全局安装CLI实用程序,您只需要将COMPOSER_HOME/vendor/bin
目录添加到您的PATH
环境变量中。
COMPOSER_HOME在Windows上是c:\Users\<user>\AppData\Roaming\Composer
,在Unix系统上是/home/<user>/.composer
。
选项4:从源代码
clic
也可以通过下载和提取存档或克隆仓库来安装。
接下来,在应用程序目录中运行composer install
以安装依赖项。
最后,将bin/
文件夹添加到您的PATH
,或将bin/clic
符号链接到您的PATH
中的某个文件夹。
初始配置
使用clic config:init
设置初始配置和目录。
全局配置存储在~/.clic-settings.json
文件中(或使用--config
选项所引用的文件)有关文件格式的更多信息可以在文档中找到,尽管你可能不需要手动编辑此文件。
使用方法
您可以从仓库或tar包中克隆/提取应用程序。然后根据应用程序的.cliconfig.json
文件定义启动一个脚本来完成安装并输入配置参数。然后可以通过添加指向应用程序的虚拟主机使其公开访问。这是一个以应用程序的web-dir
为目标的符号链接。这样,不应公开访问的文件就不会出现在文档根目录中。
应用程序
用于操作应用程序的命令可在application
命名空间内使用。
application:add Add an existing application
application:clone Create a new application from remote repository
application:execute Executes application scripts
application:extract Create a new application from an archive
application:list Lists all applications
application:override Changes the configuration file for an application
application:remove Removes an application
application:show Shows application information
application:variable:get Shows variable value for an application
application:variable:set Sets variable value for an application
详细信息请参考文档中的应用程序部分
虚拟主机
用于操作虚拟主机的命令可在vhost
命名空间内使用。
vhost:add Add web-accessible entrypoint to an application
vhost:disable Disables one or more vhosts
vhost:enable Enables one or more vhosts
vhost:fix Fixes one or more vhosts
vhost:list Lists all vhosts
vhost:remove Remove web-accessible entrypoint to an application
vhost:show Shows vhost information
详细信息请参考文档中的虚拟主机部分
仓库
可以使用clic
管理私有仓库的ssh部署密钥。它们位于repository
命名空间中。
repository:add Add deploy key to a repository
repository:generate-key Generates deploy key to a repository
repository:list Lists all repositories
repository:remove Remove deploy key from a repository
repository:show Shows repository information
详细信息请参考文档中的仓库部分
配置
所有配置参数都可以使用config
命名空间中的命令进行操作。这些是低级命令,大多数时候使用高级命令来操作这些值。
config:get Shows configuration value
config:init Initialize configuration
config:set Sets configuration values
config:unset Removes configuration values
详细信息请参考文档中的配置部分