composer-docs/03-cli.md

571 lines
23 KiB
Markdown
Raw Permalink Normal View History

2014-01-30 12:09:29 -05:00
<a name="Command-line-interface"></a>
2014-01-02 07:50:56 -05:00
# 命令行
2014-01-01 09:50:17 -05:00
2014-01-02 07:50:56 -05:00
你已经学会了如何使用命令行界面做一些事情。本章将向你介绍所有可用的命令。
2014-01-01 09:50:17 -05:00
2014-01-02 07:50:56 -05:00
为了从命令行获得帮助信息,请运行 `composer` 或者 `composer list` 命令,然后结合 `--help` 命令来获得更多的帮助信息。
2014-01-01 09:50:17 -05:00
2014-01-04 08:35:57 -05:00
---
2014-01-30 12:09:29 -05:00
- [命令行](#Command-line-interface)
- [全局参数](#Global-Options)
- [进程退出代码](#Process-Exit-Codes)
2014-01-07 19:50:51 -05:00
- [初始化 `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)
2014-01-30 12:09:29 -05:00
- [更改配置 `config`](#config) - - [使用方法](#config-Usage) - - [参数](#config-Options) - - [修改包来源](#Modifying-Repositories)
2014-01-07 19:50:51 -05:00
- [创建项目 `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)
2014-01-30 12:09:29 -05:00
- [环境变量](#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_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)
2014-01-04 08:35:57 -05:00
---
2014-01-30 12:09:29 -05:00
<a name="Global-Options"></a>
2014-01-03 04:47:30 -05:00
## 全局参数
2014-01-01 09:50:17 -05:00
2014-01-03 04:47:30 -05:00
下列参数可与每一个命令结合使用:
2014-01-01 09:50:17 -05:00
2014-01-02 08:28:48 -05:00
* **--verbose (-v):** 增加反馈信息的详细度。
* -v 表示正常输出。
* -vv 表示更详细的输出。
* -vvv 则是为了 debug。
* **--help (-h):** 显示帮助信息。
* **--quiet (-q):** 禁止输出任何信息。
* **--no-interaction (-n):** 不要询问任何交互问题。
* **--working-dir (-d):** 如果指定的话,使用给定的目录作为工作目录。
* **--profile:** 显示时间和内存使用信息。
* **--ansi:** 强制 ANSI 输出。
* **--no-ansi:** 关闭 ANSI 输出。
* **--version (-V):** 显示当前应用程序的版本信息。
2014-01-30 12:09:29 -05:00
<a name="Process-Exit-Codes"></a>
2014-01-02 08:28:48 -05:00
## 进程退出代码
* **0:** 正常
* **1:** 通用/未知错误
* **2:** 依赖关系处理错误
2014-01-07 19:54:51 -05:00
<a name="init"></a>
2014-01-02 08:28:48 -05:00
## 初始化 `init`
在 [“库”](02-libraries.md) 那一章我们看到了如何手动创建 `composer.json` 文件。实际上还有一个 `init` 命令可以更容易的做到这一点。
当您运行该命令,它会以交互方式要求您填写一些信息,同时聪明的使用一些默认值。
2014-01-01 09:50:17 -05:00
```sh
php composer.phar init
```
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="init-Options"></a>
2014-01-03 19:32:06 -05:00
### 初始化-参数
2014-01-01 09:50:17 -05:00
2014-01-02 08:28:48 -05:00
* **--name:** 包的名称。
* **--description:** 包的描述。
* **--author:** 包的作者。
* **--homepage:** 包的主页。
* **--require:** 需要依赖的其它包,必须要有一个版本约束。并且应该遵循 `foo/bar:1.0.0` 这样的格式。
* **--require-dev:** 开发版的依赖包,内容格式与 **--require** 相同。
* **--stability (-s):** `minimum-stability` 字段的值。
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="install"></a>
2014-01-02 08:28:48 -05:00
## 安装 `install`
2014-01-01 09:50:17 -05:00
2014-01-02 19:57:46 -05:00
`install` 命令从当前目录读取 `composer.json` 文件,处理了依赖关系,并把其安装到 `vendor` 目录下。
2014-01-01 09:50:17 -05:00
```sh
php composer.phar install
```
2014-01-01 09:50:17 -05:00
2018-12-11 21:00:11 -05:00
如果当前目录存在 `composer.lock` 文件,它会从此文件读取依赖版本,而不是根据 `composer.json` 文件去获取依赖。这确保了该库的每个使用者都能得到相同的依赖版本。
2014-01-01 09:50:17 -05:00
2014-01-02 19:57:46 -05:00
如果没有 `composer.lock` 文件composer 将在处理完依赖关系后创建它。
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="install-Options"></a>
2014-01-03 19:32:06 -05:00
### 安装-参数
2014-01-01 09:50:17 -05:00
2014-01-02 19:57:46 -05:00
* **--prefer-source:** 下载包的方式有两种: `source`
`dist`。对于稳定版本 composer 将默认使用 `dist` 方式。而 `source` 表示版本控制源 。如果 `--prefer-source` 是被启用的composer 将从 `source` 安装(如果有的话)。如果想要使用一个 bugfix 到你的项目,这是非常有用的。并且可以直接从本地的版本库直接获取依赖关系。
2014-01-03 02:23:59 -05:00
* **--prefer-dist:** 与 `--prefer-source` 相反composer 将尽可能的从 `dist` 获取,这将大幅度的加快在 build servers 上的安装。这也是一个回避 git 问题的途径,如果你不清楚如何正确的设置。
* **--dry-run:** 如果你只是想演示而并非实际安装一个包,你可以运行 `--dry-run` 命令,它将模拟安装并显示将会发生什么。
* **--dev:** 安装 `require-dev` 字段中列出的包(这是一个默认值)。
* **--no-dev:** 跳过 `require-dev` 字段中列出的包。
* **--no-scripts:** 跳过 `composer.json` 文件中定义的脚本。
* **--no-plugins:** 关闭 plugins。
* **--no-progress:** 移除进度信息,这可以避免一些不处理换行的终端或脚本出现混乱的显示。
* **--optimize-autoloader (-o):** 转换 PSR-0/4 autoloading 到 classmap 可以获得更快的加载支持。特别是在生产环境下建议这么做,但由于运行需要一些时间,因此并没有作为默认值。
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="update"></a>
2014-01-02 08:28:48 -05:00
## 更新 `update`
2014-01-01 09:50:17 -05:00
2014-01-03 02:23:59 -05:00
为了获取依赖的最新版本,并且升级 `composer.lock` 文件,你应该使用 `update` 命令。
2014-01-01 09:50:17 -05:00
```sh
php composer.phar update
```
2014-01-01 09:50:17 -05:00
2014-01-03 02:23:59 -05:00
这将解决项目的所有依赖,并将确切的版本号写入 `composer.lock`
2014-01-01 09:50:17 -05:00
2014-01-03 02:23:59 -05:00
如果你只是想更新几个包,你可以像这样分别列出它们:
2014-01-01 09:50:17 -05:00
```sh
php composer.phar update vendor/package vendor/package2
```
2014-01-01 09:50:17 -05:00
2014-01-03 02:23:59 -05:00
你还可以使用通配符进行批量更新:
2014-01-01 09:50:17 -05:00
```sh
php composer.phar update vendor/*
```
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="update-Options"></a>
2014-01-03 19:32:06 -05:00
### 更新-参数
2014-01-01 09:50:17 -05:00
2014-01-03 02:23:59 -05:00
* **--prefer-source:** 当有可用的包时,从 `source` 安装。
* **--prefer-dist:** 当有可用的包时,从 `dist` 安装。
* **--dry-run:** 模拟命令,并没有做实际的操作。
* **--dev:** 安装 `require-dev` 字段中列出的包(这是一个默认值)。
* **--no-dev:** 跳过 `require-dev` 字段中列出的包。
* **--no-scripts:** 跳过 `composer.json` 文件中定义的脚本。
* **--no-plugins:** 关闭 plugins。
* **--no-progress:** 移除进度信息,这可以避免一些不处理换行的终端或脚本出现混乱的显示。
* **--optimize-autoloader (-o):** 转换 PSR-0/4 autoloading 到 classmap 可以获得更快的加载支持。特别是在生产环境下建议这么做,但由于运行需要一些时间,因此并没有作为默认值。
2014-01-03 02:23:59 -05:00
* **--lock:** 仅更新 lock 文件的 hash取消有关 lock 文件过时的警告。
* **--with-dependencies** 同时更新白名单内包的依赖关系,这将进行递归更新。
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="require"></a>
2014-01-02 08:28:48 -05:00
## 申明依赖 `require`
2014-01-01 09:50:17 -05:00
2014-01-03 02:23:59 -05:00
`require` 命令增加新的依赖包到当前目录的 `composer.json` 文件中。
2014-01-01 09:50:17 -05:00
```sh
php composer.phar require
```
2014-01-01 09:50:17 -05:00
2014-01-03 02:23:59 -05:00
在添加或改变依赖时, 修改后的依赖关系将被安装或者更新。
2014-01-01 09:50:17 -05:00
2014-01-03 02:23:59 -05:00
如果你不希望通过交互来指定依赖包,你可以在这条令中直接指明依赖包。
2014-01-01 09:50:17 -05:00
```sh
php composer.phar require vendor/package:2.* vendor/package2:dev-master
```
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="require-Options"></a>
2014-01-03 19:32:06 -05:00
### 申明依赖-参数
2014-01-01 09:50:17 -05:00
2014-01-03 02:23:59 -05:00
* **--prefer-source:** 当有可用的包时,从 `source` 安装。
* **--prefer-dist:** 当有可用的包时,从 `dist` 安装。
* **--dev:** 安装 `require-dev` 字段中列出的包。
* **--no-update:** 禁用依赖关系的自动更新。
* **--no-progress:** 移除进度信息,这可以避免一些不处理换行的终端或脚本出现混乱的显示。
* **--update-with-dependencies** 一并更新新装包的依赖。
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="global"></a>
2014-01-03 04:47:30 -05:00
## 全局执行 `global`
2014-01-01 09:50:17 -05:00
2014-01-30 12:28:36 -05:00
`global` 命令允许你在 [COMPOSER_HOME](#COMPOSER_HOME) 目录下执行其它命令,像 `install`、`require` 或 `update`
2014-01-01 09:50:17 -05:00
2014-01-03 04:47:30 -05:00
并且如果你将 `$COMPOSER_HOME/vendor/bin` 加入到了 `$PATH` 环境变量中,你就可以用它在命令行中安装全局应用,下面是一个例子:
2014-01-01 09:50:17 -05:00
```sh
php composer.phar global require fabpot/php-cs-fixer:dev-master
```
2014-01-01 09:50:17 -05:00
2014-01-03 04:47:30 -05:00
现在 `php-cs-fixer` 就可以在全局范围使用了(假设你已经设置了你的 PATH。如果稍后你想更新它你只需要运行 `global update`
2014-01-01 09:50:17 -05:00
```sh
php composer.phar global update
```
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="search"></a>
2014-01-03 04:47:30 -05:00
## 搜索 `search`
2014-01-01 09:50:17 -05:00
2014-01-03 04:47:30 -05:00
`search` 命令允许你为当前项目搜索依赖包,通常它只搜索 packagist.org 上的包,你可以简单的输入你的搜索条件。
2014-01-01 09:50:17 -05:00
```sh
php composer.phar search monolog
```
2014-01-01 09:50:17 -05:00
2014-01-03 04:47:30 -05:00
您也可以通过传递多个参数来进行多条件搜索。
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="search-Options"></a>
2014-01-03 19:32:06 -05:00
### 搜索-参数
2014-01-01 09:50:17 -05:00
2014-01-03 04:47:30 -05:00
* **--only-name (-N):** 仅针对指定的名称搜索(完全匹配)。
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="show"></a>
2014-01-03 04:47:30 -05:00
## 展示 `show`
2014-01-01 09:50:17 -05:00
2014-01-03 04:47:30 -05:00
列出所有可用的软件包,你可以使用 `show` 命令。
2014-01-01 09:50:17 -05:00
```sh
php composer.phar show
```
2014-01-01 09:50:17 -05:00
2014-01-03 04:47:30 -05:00
如果你想看到一个包的详细信息,你可以输入一个包名称。
2014-01-01 09:50:17 -05:00
```sh
php composer.phar show monolog/monolog
2014-01-01 09:50:17 -05:00
name : monolog/monolog
versions : master-dev, 1.0.2, 1.0.1, 1.0.0, 1.0.0-RC1
type : library
names : monolog/monolog
source : [git] http://github.com/Seldaek/monolog.git 3d4e60d0cbc4b888fe5ad223d77964428b1978da
dist : [zip] http://github.com/Seldaek/monolog/zipball/3d4e60d0cbc4b888fe5ad223d77964428b1978da 3d4e60d0cbc4b888fe5ad223d77964428b1978da
license : MIT
2014-01-01 09:50:17 -05:00
autoload
psr-0
Monolog : src/
2014-01-01 09:50:17 -05:00
requires
php >=5.3.0
```
2014-01-01 09:50:17 -05:00
2014-01-03 04:47:30 -05:00
你甚至可以输入一个软件包的版本号,来显示该版本的详细信息。
2014-01-01 09:50:17 -05:00
```sh
php composer.phar show monolog/monolog 1.0.2
```
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="show-Options"></a>
2014-01-03 19:32:06 -05:00
### 展示-参数
2014-01-01 09:50:17 -05:00
2014-01-03 04:47:30 -05:00
* **--installed (-i):** 列出已安装的依赖包。
* **--platform (-p):** 仅列出平台软件包PHP 与它的扩展)。
* **--self (-s):** 仅列出当前项目信息。
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="depends"></a>
2014-01-03 04:47:30 -05:00
## 依赖性检测 `depends`
2014-01-01 09:50:17 -05:00
2014-01-03 04:47:30 -05:00
`depends` 命令可以查出已安装在你项目中的某个包,是否正在被其它的包所依赖,并列出他们。
2014-01-01 09:50:17 -05:00
```sh
php composer.phar depends --link-type=require monolog/monolog
2014-01-01 09:50:17 -05:00
nrk/monolog-fluent
poc/poc
propel/propel
symfony/monolog-bridge
symfony/symfony
```
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="depends-Options"></a>
2014-01-03 19:32:06 -05:00
### 依赖性检测-参数
2014-01-01 09:50:17 -05:00
2014-01-03 04:47:30 -05:00
* **--link-type:** 检测的类型,默认为 `require` 也可以是 `require-dev`
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="validate"></a>
2014-01-03 04:47:30 -05:00
## 有效性检测 `validate`
2014-01-01 09:50:17 -05:00
2014-01-03 04:47:30 -05:00
在提交 `composer.json` 文件,和创建 tag 前,你应该始终运行 `validate` 命令。它将检测你的 `composer.json` 文件是否是有效的
2014-01-01 09:50:17 -05:00
```sh
php composer.phar validate
```
### 有效性检测参数
* **--no-check-all:** Composer 是否进行完整的校验。
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="status"></a>
2014-01-03 10:12:55 -05:00
## 依赖包状态检测 `status`
2014-01-01 09:50:17 -05:00
2014-01-03 10:12:55 -05:00
如果你经常修改依赖包里的代码,并且它们是从 source自定义源进行安装的那么 `status` 命令允许你进行检查,如果你有任何本地的更改它将会给予提示。
2014-01-01 09:50:17 -05:00
```sh
php composer.phar status
```
2014-01-01 09:50:17 -05:00
2014-01-03 10:12:55 -05:00
你可以使用 `--verbose` 系列参数(-v|vv|vvv来获取更详细的详细
2014-01-01 09:50:17 -05:00
```sh
php composer.phar status -v
You have changes in the following dependencies:
vendor/seld/jsonlint:
M README.mdown
```
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="self-update"></a>
2014-01-03 19:32:06 -05:00
## 自我更新 `self-update`
2014-01-01 09:50:17 -05:00
2014-01-03 19:32:06 -05:00
将 Composer 自身升级到最新版本,只需要运行 `self-update` 命令。它将替换你的 `composer.phar` 文件到最新版本。
2014-01-01 09:50:17 -05:00
```sh
php composer.phar self-update
```
2014-01-01 09:50:17 -05:00
2014-01-03 19:32:06 -05:00
如果你想要升级到一个特定的版本,可以这样简单的指定它:
2014-01-01 09:50:17 -05:00
```sh
php composer.phar self-update 1.0.0-alpha7
```
2014-01-01 09:50:17 -05:00
2014-01-03 19:32:06 -05:00
如果你已经为整个系统安装 Composer参见 [全局安装](00-intro.md#全局安装)),你可能需要在 `root` 权限下运行它:
2014-01-01 09:50:17 -05:00
```sh
sudo composer self-update
```
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="self-update-Options"></a>
2014-01-03 19:32:06 -05:00
### 自我更新-参数
2014-01-01 09:50:17 -05:00
2014-01-03 19:32:06 -05:00
* **--rollback (-r):** 回滚到你已经安装的最后一个版本。
* **--clean-backups:** 在更新过程中删除旧的备份,这使得更新过后的当前版本是唯一可用的备份。
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="config"></a>
2014-01-03 19:32:06 -05:00
## 更改配置 `config`
2014-01-01 09:50:17 -05:00
2014-01-03 19:32:06 -05:00
`config` 命令允许你编辑 Composer 的一些基本设置,无论是本地的 `composer.json` 或者全局的 `config.json` 文件。
2014-01-01 09:50:17 -05:00
```sh
php composer.phar config --list
```
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="config-Usage"></a>
2014-01-03 19:32:06 -05:00
### 更改配置-使用方法
2014-01-01 09:50:17 -05:00
`config [options] [setting-key] [setting-value1] ... [setting-valueN]`
2014-01-03 19:32:06 -05:00
`setting-key` 是一个配置选项的名称,`setting-value1` 是一个配置的值。可以使用数组作为配置的值(像 `github-protocols`),多个 `setting-value` 是允许的。
2014-01-01 09:50:17 -05:00
2014-01-03 19:32:06 -05:00
有效的配置选项,请查看“架构”章节的 [config](04-schema.md#config) 。
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="config-Options"></a>
2014-01-03 19:32:06 -05:00
### 更改配置-参数
2014-01-01 09:50:17 -05:00
2014-01-03 19:32:06 -05:00
* **--global (-g):** 操作位于 `$COMPOSER_HOME/config.json` 的全局配置文件。如果不指定该参数,此命令将影响当前项目的 composer.json 文件,或 `--file` 参数所指向的文件。
* **--editor (-e):** 使用文本编辑器打开 composer.json 文件。默认情况下始终是打开当前项目的文件。当存在 `--global` 参数时,将会打开全局 composer.json 文件。
* **--unset:** 移除由 `setting-key` 指定名称的配置选项。
* **--list (-l):** 显示当前配置选项的列表。当存在 `--global` 参数时,将会显示全局配置选项的列表。
* **--file="..." (-f):** 在一个指定的文件上操作,而不是 composer.json。注意不能与 `--global` 参数一起使用。
2014-01-01 09:50:17 -05:00
2014-01-30 12:09:29 -05:00
<a name="Modifying-Repositories"></a>
2014-01-03 19:32:06 -05:00
### 修改包来源
2014-01-01 09:50:17 -05:00
2014-01-03 19:32:06 -05:00
除了修改配置选项, `config` 命令还支持通过以下方法修改来源信息:
2014-01-01 09:50:17 -05:00
```sh
php composer.phar config repositories.foo vcs http://github.com/foo/bar
```
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="create-project"></a>
2014-01-03 19:32:06 -05:00
## 创建项目 `create-project`
2014-01-01 09:50:17 -05:00
2014-01-03 19:32:06 -05:00
你可以使用 Composer 从现有的包中创建一个新的项目。这相当于执行了一个 `git clone``svn checkout` 命令后将这个包的依赖安装到它自己的 vendor 目录。
2014-01-01 09:50:17 -05:00
2014-01-03 19:32:06 -05:00
此命令有几个常见的用途:
2014-01-01 09:50:17 -05:00
2014-01-03 19:32:06 -05:00
1. 你可以快速的部署你的应用。
2014-01-03 21:28:52 -05:00
2. 你可以检出任何资源包,并开发它的补丁。
2014-01-03 19:32:06 -05:00
3. 多人开发项目,可以用它来加快应用的初始化。
2014-01-01 09:50:17 -05:00
2014-01-03 19:32:06 -05:00
要创建基于 Composer 的新项目,你可以使用 "create-project" 命令。传递一个包名,它会为你创建项目的目录。你也可以在第三个参数中指定版本号,否则将获取最新的版本。
2014-01-01 09:50:17 -05:00
2014-01-03 19:32:06 -05:00
如果该目录目前不存在,则会在安装过程中自动创建。
2014-01-01 09:50:17 -05:00
```sh
php composer.phar create-project doctrine/orm path 2.2.*
```
2014-01-01 09:50:17 -05:00
2014-01-03 19:32:06 -05:00
此外,你也可以无需使用这个命令,而是通过现有的 `composer.json` 文件来启动这个项目。
2014-01-01 09:50:17 -05:00
2014-01-03 19:32:06 -05:00
默认情况下,这个命令会在 packagist.org 上查找你指定的包。
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="create-project-Options"></a>
2014-01-03 19:32:06 -05:00
### 创建项目-参数
2014-01-01 09:50:17 -05:00
2014-01-03 21:28:52 -05:00
* **--repository-url:** 提供一个自定义的储存库来搜索包,这将被用来代替 packagist.org。可以是一个指向 `composer` 资源库的 HTTP URL或者是指向某个 `packages.json` 文件的本地路径。
* **--stability (-s):** 资源包的最低稳定版本,默认为 `stable`
* **--prefer-source:** 当有可用的包时,从 `source` 安装。
* **--prefer-dist:** 当有可用的包时,从 `dist` 安装。
* **--dev:** 安装 `require-dev` 字段中列出的包。
* **--no-install:** 禁止安装包的依赖。
* **--no-plugins:** 禁用 plugins。
* **--no-scripts:** 禁止在根资源包中定义的脚本执行。
* **--no-progress:** 移除进度信息,这可以避免一些不处理换行的终端或脚本出现混乱的显示。
* **--keep-vcs:** 创建时跳过缺失的 VCS 。如果你在非交互模式下运行创建命令,这将是非常有用的。
2014-01-07 19:54:51 -05:00
<a name="dump-autoload"></a>
2014-01-03 21:28:52 -05:00
## 打印自动加载索引 `dump-autoload`
某些情况下你需要更新 autoloader例如在你的包中加入了一个新的类。你可以使用 `dump-autoload` 来完成,而不必执行 `install``update` 命令。
此外,它可以打印一个优化过的,符合 PSR-0/4 规范的类的索引,这也是出于对性能的可考虑。在大型的应用中会有许多类文件,而 autoloader 会占用每个请求的很大一部分时间,使用 classmaps 或许在开发时不太方便,但它在保证性能的前提下,仍然可以获得 PSR-0/4 规范带来的便利。
2014-01-03 21:28:52 -05:00
2014-01-07 19:54:51 -05:00
<a name="dump-autoload-Options"></a>
2014-01-03 21:28:52 -05:00
### 打印自动加载索引-参数
2014-01-01 09:50:17 -05:00
* **--optimize (-o):** 转换 PSR-0/4 autoloading 到 classmap 获得更快的载入速度。这特别适用于生产环境,但可能需要一些时间来运行,因此它目前不是默认设置。
* **--no-dev:** 禁用 autoload-dev 规则。
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="licenses"></a>
2014-01-04 01:54:47 -05:00
## 查看许可协议 `licenses`
2014-01-01 09:50:17 -05:00
2014-01-04 01:54:47 -05:00
列出已安装的每个包的名称、版本、许可协议。可以使用 `--format=json` 参数来获取 JSON 格式的输出。
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="run-script"></a>
2014-01-04 01:54:47 -05:00
## 执行脚本 `run-script`
2014-01-01 09:50:17 -05:00
你可以运行此命令来手动执行 [脚本](articles/scripts.md),只需要指定脚本的名称,可选的 `--no-dev` 参数允许你禁用开发者模式。
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="diagnose"></a>
2014-01-04 09:31:33 -05:00
## 诊断 `diagnose`
2014-01-01 09:50:17 -05:00
2014-01-04 01:54:47 -05:00
如果你觉得发现了一个 bug 或是程序行为变得怪异,你可能需要运行 `diagnose` 命令,来帮助你检测一些常见的问题。
2014-01-01 09:50:17 -05:00
```sh
php composer.phar diagnose
```
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="archive"></a>
2014-01-04 01:54:47 -05:00
## 归档 `archive`
2014-01-01 09:50:17 -05:00
2014-01-04 01:54:47 -05:00
此命令用来对指定包的指定版本进行 zip/tar 归档。它也可以用来归档你的整个项目,不包括 excluded/ignored排除/忽略)的文件。
2014-01-01 09:50:17 -05:00
```sh
php composer.phar archive vendor/package 2.0.21 --format=zip
```
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="archive-Options"></a>
2014-01-04 01:54:47 -05:00
### 归档-参数
2014-01-01 09:50:17 -05:00
2014-01-04 01:54:47 -05:00
* **--format (-f):** 指定归档格式tar 或 zip默认为 tar
* **--dir:** 指定归档存放的目录(默认为当前目录)。
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="help"></a>
2014-01-04 01:54:47 -05:00
## 获取帮助信息 `help`
2014-01-01 09:50:17 -05:00
2014-01-04 01:54:47 -05:00
使用 `help` 可以获取指定命令的帮助信息。
2014-01-01 09:50:17 -05:00
```sh
php composer.phar help install
```
2014-01-01 09:50:17 -05:00
2014-01-30 12:09:29 -05:00
<a name="Environment-variables"></a>
2014-01-04 01:54:47 -05:00
## 环境变量
2014-01-01 09:50:17 -05:00
2014-01-04 01:54:47 -05:00
你可以设置一些环境变量来覆盖默认的配置。建议尽可能的在 `composer.json``config` 字段中设置这些值,而不是通过命令行设置环境变量。值得注意的是环境变量中的值,将始终优先于 `composer.json` 中所指定的值。
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="COMPOSER"></a>
2014-01-01 09:50:17 -05:00
### COMPOSER
2014-01-04 01:54:47 -05:00
环境变量 `COMPOSER` 可以为 `composer.json` 文件指定其它的文件名。
2014-01-01 09:50:17 -05:00
2014-01-04 01:54:47 -05:00
例如:
2014-01-01 09:50:17 -05:00
```sh
COMPOSER=composer-other.json php composer.phar install
```
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="COMPOSER_ROOT_VERSION"></a>
2014-01-01 09:50:17 -05:00
### COMPOSER_ROOT_VERSION
2014-01-04 01:54:47 -05:00
通过设置这个环境变量,你可以指定 root 包的版本,如果程序不能从 VCS 上猜测出版本号,并且未在 `composer.json` 文件中申明。
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="COMPOSER_VENDOR_DIR"></a>
2014-01-01 09:50:17 -05:00
### COMPOSER_VENDOR_DIR
2014-01-04 01:54:47 -05:00
通过设置这个环境变量,你可以指定 composer 将依赖安装在 `vendor` 以外的其它目录中。
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="COMPOSER_BIN_DIR"></a>
2014-01-01 09:50:17 -05:00
### COMPOSER_BIN_DIR
通过设置这个环境变量,你可以指定 `bin`[Vendor Binaries](articles/vendor-binaries.md))目录到 `vendor/bin` 以外的其它目录。
2014-01-01 09:50:17 -05:00
2014-01-30 12:09:29 -05:00
<a name="http_proxy-or-HTTP_PROXY"></a>
2014-01-01 09:50:17 -05:00
### http_proxy or HTTP_PROXY
2014-01-04 01:54:47 -05:00
如果你是通过 HTTP 代理来使用 Composer你可以使用 `http_proxy``HTTP_PROXY` 环境变量。只要简单的将它设置为代理服务器的 URL。许多操作系统已经为你的服务设置了此变量。
2014-01-01 09:50:17 -05:00
2014-01-04 01:54:47 -05:00
建议使用 `http_proxy`(小写)或者两者都进行定义。因为某些工具,像 git 或 curl 将使用 `http_proxy` 小写的版本。另外,你还可以使用 `git config --global http.proxy <proxy url>` 来单独设置 git 的代理。
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="no_proxy"></a>
2014-01-01 09:50:17 -05:00
### no_proxy
2014-01-04 04:02:11 -05:00
如果你是使用代理服务器,并且想要对某些域名禁用代理,就可以使用 `no_proxy` 环境变量。只需要输入一个逗号相隔的域名 *排除* 列表。
2014-01-01 09:50:17 -05:00
2014-01-04 04:02:11 -05:00
此环境变量接受域名、IP 以及 CIDR地址块。你可以将它限制到一个端口例如`:80`)。你还可以把它设置为 `*` 来忽略所有的 HTTP 代理请求。
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="HTTP_PROXY_REQUEST_FULLURI"></a>
2014-01-01 09:50:17 -05:00
### HTTP_PROXY_REQUEST_FULLURI
2014-01-04 04:02:11 -05:00
如果你使用了 HTTP 代理,但它不支持 `request_fulluri` 标签,那么你应该设置这个环境变量为 `false``0` ,来防止 composer 从 `request_fulluri` 读取配置。
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="HTTPS_PROXY_REQUEST_FULLURI"></a>
2014-01-01 09:50:17 -05:00
### HTTPS_PROXY_REQUEST_FULLURI
2014-01-04 04:02:11 -05:00
如果你使用了 HTTPS 代理,但它不支持 `request_fulluri` 标签,那么你应该设置这个环境变量为 `false``0` ,来防止 composer 从 `request_fulluri` 读取配置。
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="COMPOSER_HOME"></a>
2014-01-01 09:50:17 -05:00
### COMPOSER_HOME
2014-01-04 04:02:11 -05:00
`COMPOSER_HOME` 环境变量允许你改变 Composer 的主目录。这是一个隐藏的、所有项目共享的全局目录(对本机的所有用户都可用)。
2014-01-01 09:50:17 -05:00
2014-01-04 04:02:11 -05:00
它在各个系统上的默认值分别为:
- \*nix `/home/<user>/.composer`
- OSX `/Users/<user>/.composer`
- Windows `C:\Users\<user>\AppData\Roaming\Composer`
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="COMPOSER_HOME-config.json"></a>
2014-01-01 09:50:17 -05:00
#### COMPOSER_HOME/config.json
2014-01-04 04:02:11 -05:00
你可以在 `COMPOSER_HOME` 目录中放置一个 `config.json` 文件。在你执行 `install``update` 命令时Composer 会将它与你项目中的 `composer.json` 文件进行合并。
2014-01-01 09:50:17 -05:00
2014-01-30 12:28:36 -05:00
该文件允许你为用户的项目设置 [配置信息](04-schema.md#config) 和 [资源库](05-repositories.md)。
2014-01-01 09:50:17 -05:00
2014-01-04 04:02:11 -05:00
_全局__项目_ 存在相同配置项,那么项目中的 `composer.json` 文件拥有更高的优先级。
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="COMPOSER_CACHE_DIR"></a>
2014-01-01 09:50:17 -05:00
### COMPOSER_CACHE_DIR
2014-01-04 04:02:11 -05:00
`COMPOSER_CACHE_DIR` 环境变量允许你设置 Composer 的缓存目录,这也可以通过 [`cache-dir`](04-schema.md#config) 进行配置。
2014-01-01 09:50:17 -05:00
2014-01-04 04:02:11 -05:00
它在各个系统上的默认值分别为:
- \*nix and OSX `$COMPOSER_HOME/cache`
- Windows `C:\Users\<user>\AppData\Local\Composer``%LOCALAPPDATA%/Composer`
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="COMPOSER_PROCESS_TIMEOUT"></a>
2014-01-01 09:50:17 -05:00
### COMPOSER_PROCESS_TIMEOUT
2014-01-04 04:02:11 -05:00
这个环境变量控制着 Composer 执行命令的等待时间例如git 命令。默认值为300秒5分钟
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="COMPOSER_DISCARD_CHANGES"></a>
2014-01-01 09:50:17 -05:00
### COMPOSER_DISCARD_CHANGES
2014-01-04 04:02:11 -05:00
这个环境变量控制着 discard-changes [config option](04-schema.md#config)。
2014-01-01 09:50:17 -05:00
2014-01-07 19:54:51 -05:00
<a name="COMPOSER_NO_INTERACTION"></a>
2014-01-01 09:50:17 -05:00
### COMPOSER_NO_INTERACTION
2014-01-04 08:35:57 -05:00
如果设置为1这个环境变量将使 Composer 在执行每一个命令时都放弃交互,相当于对所有命令都使用了 `--no-interaction`。可以在搭建 *虚拟机/持续集成服务器* 时这样设置。
2014-01-01 09:50:17 -05:00
2014-01-07 08:29:54 -05:00
&larr; [库(资源包)](02-libraries.md) | [架构](04-schema.md) &rarr;