# 命令行界面
<p class="uk-article-lead">Pagekit 通過它的命令行界面（CLI）暴露了它面向開發者的一些核心功能。許多命令都可以提供有用的工具和助手。</p>
## 基礎用法
打開終端，并進入已安裝的 Pagekit 的目錄中。該目錄中的`pagekit`腳本（不是文件擴展）是一個 PHP 腳本，它可以從命令行中運行。
```sh
cd /var/www/pagekit # navigate to pagekit directory
./pagekit # run pagekit CLI script
```
**Note** 你可能需要用`chmod +x pagekit`命令來讓這個腳本可運行。或者，可以直接調用 PHP 解釋器 `php pagekit`。
在不使用參數調用 CLI 工具時，它會輸出 Pagekit 的版本號，一些基礎的使用方法信息以及可用的命令列表。
```txt
$ ./pagekit
Pagekit version 1.0.3
Usage:
command [options] [arguments]
Options:
-h, --help 顯示此命令的幫助信息
-q, --quiet 不輸出任何信息
-V, --version 顯示應用程序的版本
--ansi 強制 ANSI 輸出
--no-ansi 禁用 ANSI 輸出
-n, --no-interaction 不詢問任何交互式問題
-v|vv|vvv, --verbose 增加信息的冗長：1，正常的輸出信息；2，更冗長的輸出；3，調試信息
可用的命令：
archive 將擴展或主題存檔
build 構建 .zip 發布文件
clearcache 清除系統緩存
help 顯示命令的幫助信息
install 安裝一個 Pagekit 包
list 列出所有命令
migrate 遷移 Pagekit
self-update 檢查 Pagekit 新版本并安裝最新版
setup Setup a Pagekit installation
start 啟動內置的 web 服務器
uninstall 卸載 Pagekit 包
update 更新 Pagekit 包的依賴
extension
extension:translate 生成擴展的翻譯文件 .pot/.po/.php
translation
translation:fetch 從 languages 倉庫獲取當前的翻譯文件
```
要運行命令，可以在調用 CLI 工具時添加一些參數。例如，在商店中安裝 Hello 擴展，可以像下面這樣做：
```sh
./pagekit install pagekit/hello
```
## 可用命令
可用命令包含面向擴展和主題開發者的助手，也有幫助 Pagekit 開發組更輕松維護 Pagekit 項目的工具（比如 `build` 命令）。
### 構建包的檔案文件/Build package archive
從主題或擴展創建可安裝的 `*.zip` 檔案文件，運行此命令并提供要構建的包的路徑。下面的命令會在 Pagekit 安裝的頂級目錄中創建一個 `pagekit-hello.zip` 文件。
例子：
```sh
./pagekit archive pagekit/hello
```
用法、參數和選項：
```sh
Usage:
archive [options] [--] <name>
Arguments:
name 包的名稱
Options:
--dir[=DIR] 將檔案寫入此目錄
```
### 構建 Pagekit 發布檔案
此命令被 Pagekit 維護者用來構建 Pagekit 發布包。它會在 Pagekit 根目錄創建一個 `*.zip` 檔案文件。發布包會用在官網的下載鏈接中，或者作為可交付的自定義安裝，比如交付給你的客戶。
例子：
```sh
./pagekit build
```
用法（無參數，無選項）：
```sh
Usage:
build
```
### 清除緩存
使用 `clearcache` 命令來清空緩存。此命令會移除緩存目錄中的所有 `*.cache` 文件，一般情況下是在 `tmp/cache` 目錄中。
例子：
```sh
./pagekit clearcache
```
用法（無參數，無選項）：
```sh
Usage:
clearcache
```
### 顯示任意 CLI 命令的用法信息
了解一個命令的實際作用和如何使用，可以使用 `help` 命令。
例子：
```sh
./pagekit help install
```
用法和參數：
```
Usage:
help [options] [--] [<command_name>]
Arguments:
command 要執行的命令
command_name 命令的名稱【默認：”help“】
Options:
--format=FORMAT 輸出格式(txt, xml, json, or md) [默認: "txt"]
```
### 從 Pagekit 商店安裝一個包
例子：
```sh
./pagekit install pagekit/hello
```
用法，參數，和選項：
```sh
Usage:
install [options] [--] <packages> (<packages>)...
Arguments:
packages [Package name]:[Version constraint]
Options:
--prefer-source Forces installation from package sources when possible, including VCS information.
```
### 列出可用的命令
使用 `list` 命令可以列出所有可用的命令。它會輸出的結果與運行不含參數的 CLI腳本產生的結果是相同的。
例子：
```sh
./pagekit list
```
用法，參數，和選項：
```sh
Usage:
list [options] [--] [<namespace>]
Arguments:
namespace 命名空間名稱
Options:
--raw To output raw command list
--format=FORMAT 輸出格式(txt, xml, json, or md) [默認: "txt"]
```
### 運行 Pagekit 遷移
在 Pagekit 新版本被安裝后，系統有時需要修改數據庫結構。這些修改被聚合在所謂的 _遷移（migrations）_ 中。要運行所需的任何遷移，可以使用 `migrate` 命令。一般來說，你并不需要明確地這樣做。當你登入到管理區域時，Pagekit 也會檢查是否有可用的遷移，如果有必要就會執行遷移程序。
Example:
```sh
./pagekit migrate
```
用法（無參數無選項）：
```sh
Usage:
migrate
```
### 升級 Pagekit
在終端升級 Pagekit。可選地，你可以提供一個用于運行升級的 Pagekit 包的鏈接。在這種情況下，你還需要提供一個有效的 SHA hash 來驗證下載的文件。如果沒有提供 URL 和 hash，此命令會使用來自于 pagekit.com 最近的 Pagekit 包。
Example:
```sh
./pagekit self-update
```
用法和選項：
```sh
Usage:
self-update [options]
Options:
-u, --url=URL
-s, --shasum=SHASUM
```
### 實施完整的 Pagekit 安裝
你可以不必打開瀏覽器，在終端執行命令來啟動全新的 Pagekit 安裝程序。這可以用于自動化安裝，面向你自己或客戶的項目。
使用 SQLite 安裝 Pagekit 和設置默認管理員用戶admin的例子：
```sh
./pagekit setup --password=<SOMETHING-SECURE>
```
用法和選項：
```sh
Usage:
setup [options]
Options:
-u, --username=USERNAME 管理員用戶名 [默認: "admin"]
-p, --password=PASSWORD 管理員用戶密碼
-t, --title[=TITLE] 網站標題 [默認: "Pagekit"]
-m, --mail[=MAIL] 管理員賬號郵箱 [默認: "admin@example.com"]
-d, --db-driver=DB-DRIVER 數據庫驅動器('sqlite' or 'mysql') [default: "sqlite"]
--db-prefix[=DB-PREFIX] 數據庫前綴 [default: "pk_"]
-H, --db-host[=DB-HOST] MySQL 主機
-N, --db-name[=DB-NAME] MySQL 數據庫名
-U, --db-user[=DB-USER] MySQL 用戶名
-P, --db-pass[=DB-PASS] MySQL 密碼
-l, --locale[=LOCALE] Locale
```
### 啟動內置的 web 服務器
實際上你不需要完整的 Apache 服務器設置。你可以在本地機器上使用 `start` 命令來運行一個獨立的服務器實例。命令會一直運行，直到你使用 CTRL+C 退出服務器實例。
```sh
./pagekit start --server=127.0.0.1:8080
```
用法和選項：
```
Usage:
start [options]
Options:
-s, --server[=SERVER] 服務器名稱和端口 [默認: "127.0.0.1:8080"]
```
### 卸載 Pagekit 包
從 Pagekit 中移除主題或擴展。
Example:
```sh
./pagekit uninstall pagekit/hello
```
用法和參數
```
Usage:
uninstall <packages> (<packages>)...
Arguments:
packages [Package name]
```
### 從包中解析翻譯字符串
在創建主題或擴展時，你可以也應該使用 Pagekit 的國際化系統使用戶界面可以顯示多種語言。簡單說，這是通過將字符串包裹在特定的函數調用（比如 PHP 模板的 `__('Translate me!')` 或 Vue 模板的 `{{ 'Translate me!' |trans }}`）中。`extension:translate` 命令會在主題或擴展中找到所有這種函數調用，并將所有可翻譯的字符串收集起來寫入到指定的包的 `languages/` 子目錄中。這些文件可以用于創建包的翻譯，比如使用 [Transifex](https://www.transifex.com/pagekit/pagekit-cms/) 這種服務。
Example:
```sh
./pagekit extension:translate pagekit/blog
```
用法和參數：
```sh
Usage:
extension:translate [<extension>]
Arguments:
extension Extension name
```
### 獲取新的翻譯文件
**棄用警告** 此命令將被替換。
This command is used by the Pagekit core maintainers to fetch translations from the Pagekit translation repository. The translation workflow and file structure is currently under discussion and this command will probably replaced in a future version of Pagekit.
Example:
```sh
./pagekit translation:fetch
```
Usage:
```sh
Usage:
translation:fetch
```
