update 03-cli.md 采用英文锚点

This commit is contained in:
成武 2014-01-08 08:50:51 +08:00
parent 8ec33d5599
commit 823297db1e
1 changed files with 87 additions and 37 deletions

View File

@ -1,3 +1,4 @@
<a href="Command-line interface"></a>
# 命令行
你已经学会了如何使用命令行界面做一些事情。本章将向你介绍所有可用的命令。
@ -6,46 +7,46 @@
---
- [命令行](#命令行)
- [全局参数](#全局参数)
- [进程退出代码](#进程退出代码)
- [初始化 `init`](#初始化-init) - - [参数](#初始化-参数)
- [安装 `install`](#安装-install) - - [参数](#安装-参数)
- [更新 `update`](#更新-update) - - [参数](#更新-参数)
- [申明依赖 `require`](#申明依赖-require) - - [参数](#申明依赖-参数)
- [全局执行 `global`](#全局执行-global)
- [搜索 `search`](#搜索-search) - - [参数](#搜索-参数)
- [展示 `show`](#展示-show) - - [参数](#展示-参数)
- [依赖性检测 `depends`](#依赖性检测-depends) - - [参数](#依赖性检测-参数)
- [有效性检测 `validate`](#有效性检测-validate)
- [依赖包状态检测 `status`](#依赖包状态检测-status)
- [自我更新 `self-update`](#自我更新-self-update) - - [参数](#自我更新-参数)
- [更改配置 `config`](#更改配置-config) - - [使用方法](#更改配置-使用方法) - - [参数](#更改配置-参数) - - [修改包来源](#修改包来源)
- [创建项目 `create-project`](#创建项目-create-project) - - [参数](#创建项目-参数)
- [打印自动加载索引 `dump-autoload`](#打印自动加载索引-dump-autoload) - - [参数](#打印自动加载索引-参数)
- [查看许可协议 `licenses`](#查看许可协议-licenses)
- [执行脚本 `run-script`](#执行脚本-run-script)
- [诊断 `diagnose`](#诊断-diagnose)
- [归档 `archive`](#归档-archive) - - [参数](#归档-参数)
- [获取帮助信息 `help`](#获取帮助信息-help)
- [环境变量](#环境变量)
- [COMPOSER](#composer)
- [COMPOSER_ROOT_VERSION](#composer_root_version)
- [COMPOSER_VENDOR_DIR](#composer_vendor_dir)
- [COMPOSER_BIN_DIR](#composer_bin_dir)
- [http_proxy or HTTP_PROXY](#http_proxy-or-http_proxy)
- [命令行](#Command-line interface)
- [全局参数](#Global Options)
- [进程退出代码](#Process Exit Codes)
- [初始化 `init`](#init) - - [参数](#init-Options)
- [安装 `install`](#install) - - [参数](#install-Options)
- [更新 `update`](#update) - - [参数](#update-Options)
- [申明依赖 `require`](#require) - - [参数](#require-Options)
- [全局执行 `global`](#global)
- [搜索 `search`](#search) - - [参数](#search-Options)
- [展示 `show`](#show) - - [参数](#show-Options)
- [依赖性检测 `depends`](#depends) - - [参数](#depends-Options)
- [有效性检测 `validate`](#validate)
- [依赖包状态检测 `status`](#status)
- [自我更新 `self-update`](#self-update) - - [参数](#self-update-Options)
- [更改配置 `config`](#config) - - [使用方法](#config-Usage) - - [参数](#config-Options) - - [修改包来源](#Modifying Repositories)
- [创建项目 `create-project`](#create-project) - - [参数](#create-project-Options)
- [打印自动加载索引 `dump-autoload`](#dump-autoload) - - [参数](#dump-autoload-Options)
- [查看许可协议 `licenses`](#licenses)
- [执行脚本 `run-script`](#run-script)
- [诊断 `diagnose`](#diagnose)
- [归档 `archive`](#archive) - - [参数](#archive-Options)
- [获取帮助信息 `help`](#help)
- [环境变量](#Environment variables)
- [COMPOSER](#COMPOSER)
- [COMPOSER_ROOT_VERSION](#COMPOSER_ROOT_VERSION)
- [COMPOSER_VENDOR_DIR](#COMPOSER_VENDOR_DIR)
- [COMPOSER_BIN_DIR](#COMPOSER_BIN_DIR)
- [http_proxy or HTTP_PROXY](#http_proxy or HTTP_PROXY)
- [no_proxy](#no_proxy)
- [HTTP_PROXY_REQUEST_FULLURI](#http_proxy_request_fulluri)
- [HTTPS_PROXY_REQUEST_FULLURI](#https_proxy_request_fulluri)
- [COMPOSER_HOME](#composer_home)
- [COMPOSER_HOME/config.json](#composer_homeconfigjson)
- [COMPOSER_CACHE_DIR](#composer_cache_dir)
- [COMPOSER_PROCESS_TIMEOUT](#composer_process_timeout)
- [COMPOSER_DISCARD_CHANGES](#composer_discard_changes)
- [COMPOSER_NO_INTERACTION](#composer_no_interaction)
- [HTTP_PROXY_REQUEST_FULLURI](#HTTP_PROXY_REQUEST_FULLURI)
- [HTTPS_PROXY_REQUEST_FULLURI](#HTTPS_PROXY_REQUEST_FULLURI)
- [COMPOSER_HOME](#COMPOSER_HOME)
- [COMPOSER_HOME/config.json](#COMPOSER_HOME-config.json)
- [COMPOSER_CACHE_DIR](#COMPOSER_CACHE_DIR)
- [COMPOSER_PROCESS_TIMEOUT](#COMPOSER_PROCESS_TIMEOUT)
- [COMPOSER_DISCARD_CHANGES](#COMPOSER_DISCARD_CHANGES)
- [COMPOSER_NO_INTERACTION](#COMPOSER_NO_INTERACTION)
---
<a href="Global Options"></a>
## 全局参数
下列参数可与每一个命令结合使用:
@ -63,12 +64,14 @@
* **--no-ansi:** 关闭 ANSI 输出。
* **--version (-V):** 显示当前应用程序的版本信息。
<a href="Process Exit Codes"></a>
## 进程退出代码
* **0:** 正常
* **1:** 通用/未知错误
* **2:** 依赖关系处理错误
<a href="init"></a>
## 初始化 `init`
在 [“库”](02-libraries.md) 那一章我们看到了如何手动创建 `composer.json` 文件。实际上还有一个 `init` 命令可以更容易的做到这一点。
@ -77,6 +80,7 @@
$ php composer.phar init
<a href="init-Options"></a>
### 初始化-参数
* **--name:** 包的名称。
@ -87,6 +91,7 @@
* **--require-dev:** 开发版的依赖包,内容格式与 **--require** 相同。
* **--stability (-s):** `minimum-stability` 字段的值。
<a href="install"></a>
## 安装 `install`
`install` 命令从当前目录读取 `composer.json` 文件,处理了依赖关系,并把其安装到 `vendor` 目录下。
@ -97,6 +102,7 @@
如果没有 `composer.lock` 文件composer 将在处理完依赖关系后创建它。
<a href="install-Options"></a>
### 安装-参数
* **--prefer-source:** 下载包的方式有两种: `source`
@ -110,6 +116,7 @@
* **--no-progress:** 移除进度信息,这可以避免一些不处理换行的终端或脚本出现混乱的显示。
* **--optimize-autoloader (-o):** 转换 PSR-0 autoloading 到 classmap 可以获得更快的加载支持。特别是在生产环境下建议这么做,但由于运行需要一些时间,因此并没有作为默认值。
<a href="update"></a>
## 更新 `update`
为了获取依赖的最新版本,并且升级 `composer.lock` 文件,你应该使用 `update` 命令。
@ -126,6 +133,7 @@
$ php composer.phar update vendor/*
<a href="update-Options"></a>
### 更新-参数
* **--prefer-source:** 当有可用的包时,从 `source` 安装。
@ -140,6 +148,7 @@
* **--lock:** 仅更新 lock 文件的 hash取消有关 lock 文件过时的警告。
* **--with-dependencies** 同时更新白名单内包的依赖关系,这将进行递归更新。
<a href="require"></a>
## 申明依赖 `require`
`require` 命令增加新的依赖包到当前目录的 `composer.json` 文件中。
@ -152,6 +161,7 @@
$ php composer.phar require vendor/package:2.* vendor/package2:dev-master
<a href="require-Options"></a>
### 申明依赖-参数
* **--prefer-source:** 当有可用的包时,从 `source` 安装。
@ -160,6 +170,7 @@
* **--no-update:** 禁用依赖关系的自动更新。
* **--no-progress:** 移除进度信息,这可以避免一些不处理换行的终端或脚本出现混乱的显示。
<a href="global"></a>
## 全局执行 `global`
`global` 命令允许你在 [COMPOSER_HOME](#composer-home) 目录下执行其它命令,像 `install`、`require` 或 `update`
@ -172,6 +183,7 @@
$ php composer.phar global update
<a href="search"></a>
## 搜索 `search`
`search` 命令允许你为当前项目搜索依赖包,通常它只搜索 packagist.org 上的包,你可以简单的输入你的搜索条件。
@ -180,10 +192,12 @@
您也可以通过传递多个参数来进行多条件搜索。
<a href="search-Options"></a>
### 搜索-参数
* **--only-name (-N):** 仅针对指定的名称搜索(完全匹配)。
<a href="show"></a>
## 展示 `show`
列出所有可用的软件包,你可以使用 `show` 命令。
@ -213,12 +227,14 @@
$ php composer.phar show monolog/monolog 1.0.2
<a href="show-Options"></a>
### 展示-参数
* **--installed (-i):** 列出已安装的依赖包。
* **--platform (-p):** 仅列出平台软件包PHP 与它的扩展)。
* **--self (-s):** 仅列出当前项目信息。
<a href="depends"></a>
## 依赖性检测 `depends`
`depends` 命令可以查出已安装在你项目中的某个包,是否正在被其它的包所依赖,并列出他们。
@ -231,16 +247,19 @@
symfony/monolog-bridge
symfony/symfony
<a href="depends-Options"></a>
### 依赖性检测-参数
* **--link-type:** 检测的类型,默认为 `require` 也可以是 `require-dev`
<a href="validate"></a>
## 有效性检测 `validate`
在提交 `composer.json` 文件,和创建 tag 前,你应该始终运行 `validate` 命令。它将检测你的 `composer.json` 文件是否是有效的
$ php composer.phar validate
<a href="status"></a>
## 依赖包状态检测 `status`
如果你经常修改依赖包里的代码,并且它们是从 source自定义源进行安装的那么 `status` 命令允许你进行检查,如果你有任何本地的更改它将会给予提示。
@ -254,6 +273,7 @@
vendor/seld/jsonlint:
M README.mdown
<a href="self-update"></a>
## 自我更新 `self-update`
将 Composer 自身升级到最新版本,只需要运行 `self-update` 命令。它将替换你的 `composer.phar` 文件到最新版本。
@ -268,17 +288,20 @@
$ sudo composer self-update
<a href="self-update-Options"></a>
### 自我更新-参数
* **--rollback (-r):** 回滚到你已经安装的最后一个版本。
* **--clean-backups:** 在更新过程中删除旧的备份,这使得更新过后的当前版本是唯一可用的备份。
<a href="config"></a>
## 更改配置 `config`
`config` 命令允许你编辑 Composer 的一些基本设置,无论是本地的 `composer.json` 或者全局的 `config.json` 文件。
$ php composer.phar config --list
<a href="config-Usage"></a>
### 更改配置-使用方法
`config [options] [setting-key] [setting-value1] ... [setting-valueN]`
@ -287,6 +310,7 @@
有效的配置选项,请查看“架构”章节的 [config](04-schema.md#config) 。
<a href="config-Options"></a>
### 更改配置-参数
* **--global (-g):** 操作位于 `$COMPOSER_HOME/config.json` 的全局配置文件。如果不指定该参数,此命令将影响当前项目的 composer.json 文件,或 `--file` 参数所指向的文件。
@ -295,12 +319,14 @@
* **--list (-l):** 显示当前配置选项的列表。当存在 `--global` 参数时,将会显示全局配置选项的列表。
* **--file="..." (-f):** 在一个指定的文件上操作,而不是 composer.json。注意不能与 `--global` 参数一起使用。
<a href="Modifying Repositories"></a>
### 修改包来源
除了修改配置选项, `config` 命令还支持通过以下方法修改来源信息:
$ php composer.phar config repositories.foo vcs http://github.com/foo/bar
<a href="create-project"></a>
## 创建项目 `create-project`
你可以使用 Composer 从现有的包中创建一个新的项目。这相当于执行了一个 `git clone``svn checkout` 命令后将这个包的依赖安装到它自己的 vendor 目录。
@ -321,6 +347,7 @@
默认情况下,这个命令会在 packagist.org 上查找你指定的包。
<a href="create-project-Options"></a>
### 创建项目-参数
* **--repository-url:** 提供一个自定义的储存库来搜索包,这将被用来代替 packagist.org。可以是一个指向 `composer` 资源库的 HTTP URL或者是指向某个 `packages.json` 文件的本地路径。
@ -334,51 +361,61 @@
* **--no-progress:** 移除进度信息,这可以避免一些不处理换行的终端或脚本出现混乱的显示。
* **--keep-vcs:** 创建时跳过缺失的 VCS 。如果你在非交互模式下运行创建命令,这将是非常有用的。
<a href="dump-autoload"></a>
## 打印自动加载索引 `dump-autoload`
某些情况下你需要更新 autoloader例如在你的包中加入了一个新的类。你可以使用 `dump-autoload` 来完成,而不必执行 `install``update` 命令。
此外,它可以打印一个优化过的,符合 PSR-0 规范的类的索引,这也是出于对性能的可考虑。在大型的应用中会有许多类文件,而 autoloader 会占用每个请求的很大一部分时间,使用 classmaps 或许在开发时不太方便,但它在保证性能的前提下,仍然可以获得 PSR-0 规范带来的便利。
<a href="dump-autoload-Options"></a>
### 打印自动加载索引-参数
* **--optimize (-o):** 转换 PSR-0 autoloading 到 classmap 获得更快的载入速度。这特别适用于生产环境,但可能需要一些时间来运行,因此它目前不是默认设置。
<a href="licenses"></a>
## 查看许可协议 `licenses`
列出已安装的每个包的名称、版本、许可协议。可以使用 `--format=json` 参数来获取 JSON 格式的输出。
<a href="run-script"></a>
## 执行脚本 `run-script`
你可以运行此命令来手动执行 [脚本](articles/scripts.md),只需要指定脚本的名称,可选的 `--no-dev` 参数允许你禁用开发者模式。
<a href="diagnose"></a>
## 诊断 `diagnose`
如果你觉得发现了一个 bug 或是程序行为变得怪异,你可能需要运行 `diagnose` 命令,来帮助你检测一些常见的问题。
$ php composer.phar diagnose
<a href="archive"></a>
## 归档 `archive`
此命令用来对指定包的指定版本进行 zip/tar 归档。它也可以用来归档你的整个项目,不包括 excluded/ignored排除/忽略)的文件。
$ php composer.phar archive vendor/package 2.0.21 --format=zip
<a href="archive-Options"></a>
### 归档-参数
* **--format (-f):** 指定归档格式tar 或 zip默认为 tar
* **--dir:** 指定归档存放的目录(默认为当前目录)。
<a href="help"></a>
## 获取帮助信息 `help`
使用 `help` 可以获取指定命令的帮助信息。
$ php composer.phar help install
<a href="Environment variables"></a>
## 环境变量
你可以设置一些环境变量来覆盖默认的配置。建议尽可能的在 `composer.json``config` 字段中设置这些值,而不是通过命令行设置环境变量。值得注意的是环境变量中的值,将始终优先于 `composer.json` 中所指定的值。
<a href="COMPOSER"></a>
### COMPOSER
环境变量 `COMPOSER` 可以为 `composer.json` 文件指定其它的文件名。
@ -387,38 +424,46 @@
$ COMPOSER=composer-other.json php composer.phar install
<a href="COMPOSER_ROOT_VERSION"></a>
### COMPOSER_ROOT_VERSION
通过设置这个环境变量,你可以指定 root 包的版本,如果程序不能从 VCS 上猜测出版本号,并且未在 `composer.json` 文件中申明。
<a href="COMPOSER_VENDOR_DIR"></a>
### COMPOSER_VENDOR_DIR
通过设置这个环境变量,你可以指定 composer 将依赖安装在 `vendor` 以外的其它目录中。
<a href="COMPOSER_BIN_DIR"></a>
### COMPOSER_BIN_DIR
通过设置这个环境变量,你可以指定 `bin`[Vendor Binaries](articles/vendor-binaries.md))目录到 `vendor/bin` 以外的其它目录。
<a href="http_proxy or HTTP_PROXY"></a>
### http_proxy or HTTP_PROXY
如果你是通过 HTTP 代理来使用 Composer你可以使用 `http_proxy``HTTP_PROXY` 环境变量。只要简单的将它设置为代理服务器的 URL。许多操作系统已经为你的服务设置了此变量。
建议使用 `http_proxy`(小写)或者两者都进行定义。因为某些工具,像 git 或 curl 将使用 `http_proxy` 小写的版本。另外,你还可以使用 `git config --global http.proxy <proxy url>` 来单独设置 git 的代理。
<a href="no_proxy"></a>
### no_proxy
如果你是使用代理服务器,并且想要对某些域名禁用代理,就可以使用 `no_proxy` 环境变量。只需要输入一个逗号相隔的域名 *排除* 列表。
此环境变量接受域名、IP 以及 CIDR地址块。你可以将它限制到一个端口例如`:80`)。你还可以把它设置为 `*` 来忽略所有的 HTTP 代理请求。
<a href="HTTP_PROXY_REQUEST_FULLURI"></a>
### HTTP_PROXY_REQUEST_FULLURI
如果你使用了 HTTP 代理,但它不支持 `request_fulluri` 标签,那么你应该设置这个环境变量为 `false``0` ,来防止 composer 从 `request_fulluri` 读取配置。
<a href="HTTPS_PROXY_REQUEST_FULLURI"></a>
### HTTPS_PROXY_REQUEST_FULLURI
如果你使用了 HTTPS 代理,但它不支持 `request_fulluri` 标签,那么你应该设置这个环境变量为 `false``0` ,来防止 composer 从 `request_fulluri` 读取配置。
<a href="COMPOSER_HOME"></a>
### COMPOSER_HOME
`COMPOSER_HOME` 环境变量允许你改变 Composer 的主目录。这是一个隐藏的、所有项目共享的全局目录(对本机的所有用户都可用)。
@ -428,6 +473,7 @@
- OSX `/Users/<user>/.composer`
- Windows `C:\Users\<user>\AppData\Roaming\Composer`
<a href="COMPOSER_HOME-config.json"></a>
#### COMPOSER_HOME/config.json
你可以在 `COMPOSER_HOME` 目录中放置一个 `config.json` 文件。在你执行 `install``update` 命令时Composer 会将它与你项目中的 `composer.json` 文件进行合并。
@ -436,6 +482,7 @@
_全局__项目_ 存在相同配置项,那么项目中的 `composer.json` 文件拥有更高的优先级。
<a href="COMPOSER_CACHE_DIR"></a>
### COMPOSER_CACHE_DIR
`COMPOSER_CACHE_DIR` 环境变量允许你设置 Composer 的缓存目录,这也可以通过 [`cache-dir`](04-schema.md#config) 进行配置。
@ -444,14 +491,17 @@
- \*nix and OSX `$COMPOSER_HOME/cache`
- Windows `C:\Users\<user>\AppData\Local\Composer``%LOCALAPPDATA%/Composer`
<a href="COMPOSER_PROCESS_TIMEOUT"></a>
### COMPOSER_PROCESS_TIMEOUT
这个环境变量控制着 Composer 执行命令的等待时间例如git 命令。默认值为300秒5分钟
<a href="COMPOSER_DISCARD_CHANGES"></a>
### COMPOSER_DISCARD_CHANGES
这个环境变量控制着 discard-changes [config option](04-schema.md#config)。
<a href="COMPOSER_NO_INTERACTION"></a>
### COMPOSER_NO_INTERACTION
如果设置为1这个环境变量将使 Composer 在执行每一个命令时都放弃交互,相当于对所有命令都使用了 `--no-interaction`。可以在搭建 *虚拟机/持续集成服务器* 时这样设置。