Deployer项目CLI命令行工具使用指南

Deployer项目CLI命令行工具使用指南

deployer The PHP deployment tool with support for popular frameworks out of the box 项目地址: https://gitcode.com/gh_mirrors/de/deployer

前言

Deployer作为一款流行的PHP部署工具，其命令行接口(CLI)提供了丰富的功能来简化部署流程。本文将深入解析Deployer CLI的各项功能和使用技巧，帮助开发者更高效地使用这一工具。

基础配置

设置命令别名

为了简化日常使用，建议在.bashrc文件中添加以下别名：

alias dep='vendor/bin/dep'

这样只需输入dep即可调用Deployer，而不需要每次都输入完整路径。

安装自动补全

Deployer支持强大的命令补全功能，可以自动补全：

• 任务名称
• 命令行选项
• 主机名称
• 配置参数

在macOS系统上安装补全功能的步骤：

brew install bash-completion
dep completion bash > /usr/local/etc/bash_completion.d/deployer

安装后，在终端输入命令时按Tab键即可获得智能提示。

配置覆盖功能

动态修改配置

部署时，有时需要临时修改配置而不想更改部署脚本。Deployer提供了-o选项来实现这一需求。

例如，部署脚本中设置了：

set('ssh_multiplexing', false);

临时启用SSH多路复用功能：

dep deploy -o ssh_multiplexing=true

多配置覆盖

可以同时覆盖多个配置项：

dep deploy -o ssh_multiplexing=true -o branch=master

这一特性特别适合在不同环境间切换部署配置。

远程命令执行

执行任意命令

Deployer允许直接在远程主机上执行命令：

dep run 'uptime -p'

这个功能可用于快速检查服务器状态或执行临时维护任务。

任务树可视化

理解任务结构

Deployer支持任务分组和前后钩子，使用tree命令可以直观展示任务间的层级关系：

$ dep tree deploy

输出示例：

└── deploy
    ├── deploy:prepare
    │   ├── deploy:info
    │   ├── deploy:setup
    │   ├── deploy:lock
    │   ├── deploy:release
    │   ├── deploy:update_code
    │   ├── build
    │   ├── deploy:shared
    │   └── deploy:writable
    ...

这种可视化展示有助于理解复杂的部署流程和调试任务执行顺序。

执行计划查看

预检部署流程

使用--plan选项可以查看任务在各主机上的执行计划：

$ dep deploy --plan all

输出为表格形式，清晰展示每个任务将在哪些主机上执行。对于配置了任务限制的情况（如limit(1)），可以直观看到任务的分布情况。

本地命令执行目录

控制执行上下文

默认情况下，runLocally()命令在部署脚本所在目录执行。可以通过以下方式修改：

全局修改（通过环境变量）：

DEPLOYER_ROOT=. dep taskname

或针对单个命令指定：

runLocally('ls', ['cwd' => '/root/directory']);

这一功能在需要从特定目录执行本地命令时非常有用。

彩蛋功能

Deployer还内置了一个有趣的彩蛋：

dep blackjack

这是对开发者的一种幽默致敬，展示了项目轻松的一面。

最佳实践建议

1. 始终为常用命令设置别名
2. 充分利用自动补全提高效率
3. 在复杂部署前使用tree和--plan检查任务结构
4. 优先使用-o选项临时修改配置，而非直接修改部署脚本
5. 合理使用执行目录控制确保命令在正确上下文中运行

通过掌握这些CLI功能，开发者可以更高效、更可控地使用Deployer完成各种部署任务。

deployer The PHP deployment tool with support for popular frameworks out of the box 项目地址: https://gitcode.com/gh_mirrors/de/deployer