本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# Greengrass CLI
<a name="greengrass-cli-component"></a>

Greengrass CLI 元件 (`aws.greengrass.Cli`) 提供本機命令列界面，您可以在核心裝置上用來在本機開發和偵錯元件。例如，Greengrass CLI 可讓您在核心裝置上建立本機部署並重新啟動元件。

您可以在安裝 AWS IoT Greengrass 核心軟體時安裝此元件。如需詳細資訊，請參閱[教學課程：入門 AWS IoT Greengrass V2](getting-started.md)。

**重要**  
 <a name="local-dev-tools-production-environment-warning"></a>我們建議您僅在開發環境中使用此元件，而不是在生產環境中。此元件可讓您存取生產環境中通常不需要的資訊和操作。僅將此元件部署到您需要的核心裝置，以遵循最低權限原則。

安裝此元件之後，請執行下列命令來檢視其說明文件。當此元件安裝時，它會`greengrass-cli`在 `/greengrass/v2/bin` 資料夾中將符號連結新增至 。您可以從此路徑執行 Greengrass CLI，或將其新增至您的`PATH`環境變數，以便在`greengrass-cli`沒有絕對路徑的情況下執行。

------
#### [ Linux or Unix ]

```
/greengrass/v2/bin/greengrass-cli help
```

------
#### [ Windows ]

```
C:\greengrass\v2\bin\greengrass-cli help
```

------

例如`com.example.HelloWorld`，下列命令會重新啟動名為 的元件。

------
#### [ Linux or Unix ]

```
sudo /greengrass/v2/bin/greengrass-cli component restart --names "com.example.HelloWorld"
```

------
#### [ Windows ]

```
C:\greengrass\v2\bin\greengrass-cli component restart --names "com.example.HelloWorld"
```

------

如需詳細資訊，請參閱[Greengrass 命令列界面](gg-cli.md)。

**Topics**
+ [版本](#greengrass-cli-component-versions)
+ [Type](#greengrass-cli-component-type)
+ [作業系統](#greengrass-cli-component-os-support)
+ [要求](#greengrass-cli-component-requirements)
+ [相依性](#greengrass-cli-component-dependencies)
+ [Configuration](#greengrass-cli-component-configuration)
+ [本機日誌檔案](#greengrass-cli-component-log-file)
+ [變更記錄](#greengrass-cli-component-changelog)

## 版本
<a name="greengrass-cli-component-versions"></a>

此元件具有下列版本：
+ 2.16.x
+ 2.15.x
+ 2.14.x
+ 2.13.x
+ 2.12.x
+ 2.11.x
+ 2.10.x
+ 2.9.x
+ 2.8.x
+ 2.7.x
+ 2.6.x
+ 2.5.x
+ 2.4.x 版本
+ 2.3.x 版本
+ 2.2.x 版本
+ 2.1.x
+ 2.0.x

## Type
<a name="greengrass-cli-component-type"></a>

<a name="public-component-type-plugin-para1"></a>此元件是外掛程式元件 (`aws.greengrass.plugin`)。[Greengrass 核會在](greengrass-nucleus-component.md)與核相同的 Java 虛擬機器 (JVM) 中執行此元件。當您在核心裝置上變更此元件的版本時，核心會重新啟動。

<a name="public-component-type-plugin-para2"></a>此元件使用與 Greengrass 核相同的日誌檔案。如需詳細資訊，請參閱[監控 AWS IoT Greengrass 日誌](monitor-logs.md)。

<a name="public-component-type-more-information"></a>如需詳細資訊，請參閱[元件類型](develop-greengrass-components.md#component-types)。

## 作業系統
<a name="greengrass-cli-component-os-support"></a>

此元件可以安裝在執行下列作業系統的核心裝置上：
+ Linux
+ Windows

## 要求
<a name="greengrass-cli-component-requirements"></a>

此元件有下列需求：
+ <a name="greengrass-cli-authorization-requirement"></a>您必須獲得使用 Greengrass CLI 與 AWS IoT Greengrass Core 軟體互動的授權。執行下列其中一項操作以使用 Greengrass CLI：
  + 使用執行 AWS IoT Greengrass Core 軟體的系統使用者。
  + 使用具有根或管理許可的使用者。在 Linux 核心裝置上，您可以使用 `sudo` 來取得根許可。
  + 當您部署元件時，請使用您在 `AuthorizedPosixGroups`或 `AuthorizedWindowsGroups`組態參數中指定的群組中的系統使用者。如需詳細資訊，請參閱 [Greengrass CLI 元件組態](#greengrass-cli-component-configuration)。
+ Greengrass CLI 元件支援在 VPC 中執行。

## 相依性
<a name="greengrass-cli-component-dependencies"></a>

當您部署元件時， AWS IoT Greengrass 也會部署其相依性的相容版本。這表示您必須符合元件及其所有相依性的要求，才能成功部署元件。本節列出此元件[發行版本的](#greengrass-cli-component-changelog)相依性，以及為每個相依性定義元件版本的語意版本限制。您也可以在 [AWS IoT Greengrass 主控台](https://console.aws.amazon.com//greengrass)中檢視每個版本元件的相依性。在元件詳細資訊頁面上，尋找**相依性**清單。

------
#### [ 2.16.0 ]

下表列出此元件 2.16.0 版的相依性。


| 相依性 | 相容版本 | 相依性類型 | 
| --- | --- | --- | 
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.12.0 <2.17.0 | 軟式 | 

------
#### [ 2.15.1 ]

下表列出此元件 2.15.1 版的相依性。


| 相依性 | 相容版本 | 相依性類型 | 
| --- | --- | --- | 
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.12.0 <2.16.0 | 軟式 | 

------
#### [ 2.15.0 ]

下表列出此元件 2.15.0 版的相依性。


| 相依性 | 相容版本 | 相依性類型 | 
| --- | --- | --- | 
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.12.0 <2.16.0 | 軟式 | 

------
#### [ 2.14.0 – 2.14.3 ]

下表列出此元件 2.14.0 和 2.14.3 版的相依性。


| 相依性 | 相容版本 | 相依性類型 | 
| --- | --- | --- | 
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.12.0 <2.15.0 | 軟式 | 

------
#### [ 2.13.0 ]

下表列出此元件 2.13.0 版的相依性。


| 相依性 | 相容版本 | 相依性類型 | 
| --- | --- | --- | 
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.12.0 <2.14.0 | 軟式 | 

------
#### [ 2.12.0 – 2.12.6 ]

下表列出此元件 2.12.0 至 2.12.6 版的相依性。


| 相依性 | 相容版本 | 相依性類型 | 
| --- | --- | --- | 
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.12.0 <2.13.0 | 軟式 | 

------
#### [ 2.11.0 – 2.11.3 ]

下表列出此元件 2.11.0 到 2.11.3 版的相依性。


| 相依性 | 相容版本 | 相依性類型 | 
| --- | --- | --- | 
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.11.0 <2.12.0 | 軟式 | 

------
#### [ 2.10.0 – 2.10.3 ]

下表列出此元件 2.10.0 到 2.10.3 版的相依性。


| 相依性 | 相容版本 | 相依性類型 | 
| --- | --- | --- | 
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.5.0 <2.11.0 | 軟式 | 

------
#### [ 2.9.0 – 2.9.6 ]

下表列出此元件 2.9.0 到 2.9.6 版的相依性。


| 相依性 | 相容版本 | 相依性類型 | 
| --- | --- | --- | 
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.5.0 <2.10.0 | 軟式 | 

------
#### [ 2.8.0 – 2.8.1 ]

下表列出此元件 2.8.0 和 2.8.1 版的相依性。


| 相依性 | 相容版本 | 相依性類型 | 
| --- | --- | --- | 
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.5.0 <2.9.0 | 軟式 | 

------
#### [ 2.7.0 ]

下表列出此元件 2.7.0 版的相依性。


| 相依性 | 相容版本 | 相依性類型 | 
| --- | --- | --- | 
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.5.0 <2.8.0 | 軟式 | 

------
#### [ 2.6.0 ]

下表列出此元件 2.6.0 版的相依性。


| 相依性 | 相容版本 | 相依性類型 | 
| --- | --- | --- | 
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.5.0 <2.7.0 | 軟式 | 

------
#### [ 2.5.0 – 2.5.6 ]

下表列出此元件 2.5.0 到 2.5.6 版的相依性。


| 相依性 | 相容版本 | 相依性類型 | 
| --- | --- | --- | 
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.5.0 <2.6.0 | 軟式 | 

------
#### [ 2.4.0 ]

下表列出此元件 2.4.0 版的相依性。


| 相依性 | 相容版本 | 相依性類型 | 
| --- | --- | --- | 
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.1.0 <2.5.0 | 軟式 | 

------
#### [ 2.3.0 ]

下表列出此元件 2.3.0 版的相依性。


| 相依性 | 相容版本 | 相依性類型 | 
| --- | --- | --- | 
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.1.0 <2.4.0 | 軟式 | 

------
#### [ 2.2.0 ]

下表列出此元件 2.2.0 版的相依性。


| 相依性 | 相容版本 | 相依性類型 | 
| --- | --- | --- | 
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.1.0 <2.3.0 | 軟式 | 

------
#### [ 2.1.0 ]

下表列出此元件 2.1.0 版的相依性。


| 相依性 | 相容版本 | 相依性類型 | 
| --- | --- | --- | 
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.1.0 <2.2.0 | 軟式 | 

------
#### [ 2.0.x ]

下表列出此元件 2.0.x 版的相依性。


| 相依性 | 相容版本 | 相依性類型 | 
| --- | --- | --- | 
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.0.0 <2.1.0 | 軟式 | 

**注意**  
Greengrass 核的最低相容版本對應至 Greengrass CLI 元件的修補程式版本。

------

如需元件相依性的詳細資訊，請參閱[元件配方參考](component-recipe-reference.md#recipe-reference-component-dependencies)。

## Configuration
<a name="greengrass-cli-component-configuration"></a>

此元件提供下列組態參數，您可以在部署元件時自訂這些參數。

------
#### [ 2.5.x - 2.14.x ]

`AuthorizedPosixGroups`  <a name="greengrass-cli-component-configuration-authorizedposixgroups"></a>
（選用） 字串，其中包含以逗號分隔的系統群組清單。您授權這些系統群組使用 Greengrass CLI 與 AWS IoT Greengrass Core 軟體互動。您可以指定群組名稱或群組 IDs。例如， 會`group1,1002,group3`授權三個系統群組 (`group1`、 `1002`和 `group3`) 使用 Greengrass CLI。  
如果您未指定任何要授權的群組，則可以使用 Greengrass CLI 做為根使用者 (`sudo`) 或執行 AWS IoT Greengrass Core 軟體的系統使用者。

`AuthorizedWindowsGroups`  <a name="greengrass-cli-component-configuration-authorizedwindowsgroups"></a>
（選用） 字串，其中包含以逗號分隔的系統群組清單。您授權這些系統群組使用 Greengrass CLI 與 AWS IoT Greengrass Core 軟體互動。您可以指定群組名稱或群組 IDs。例如， 會`group1,1002,group3`授權三個系統群組 (`group1`、 `1002`和 `group3`) 使用 Greengrass CLI。  
如果您未指定任何要授權的群組，則可以使用 Greengrass CLI 做為管理員或執行 AWS IoT Greengrass Core 軟體的系統使用者。

**Example 範例：組態合併更新**  
下列範例組態指定 授權三個 POSIX 系統群組 (`group1`、 和 `group3`) `1002`和兩個 Windows 使用者群組 (`Device Operators` 和 `QA Engineers`) 使用 Greengrass CLI。  

```
{
  "AuthorizedPosixGroups": "group1,1002,group3",
  "AuthorizedWindowsGroups": "Device Operators,QA Engineers"
}
```

------
#### [ 2.4.x - 2.0.x ]

`AuthorizedPosixGroups`  <a name="greengrass-cli-component-configuration-authorizedposixgroups"></a>
（選用） 字串，其中包含以逗號分隔的系統群組清單。您授權這些系統群組使用 Greengrass CLI 與 AWS IoT Greengrass Core 軟體互動。您可以指定群組名稱或群組 IDs。例如， 會`group1,1002,group3`授權三個系統群組 (`group1`、 `1002`和 `group3`) 使用 Greengrass CLI。  
如果您未指定任何要授權的群組，則可以使用 Greengrass CLI 做為根使用者 (`sudo`) 或執行 AWS IoT Greengrass Core 軟體的系統使用者。

**Example 範例：組態合併更新**  
下列範例組態指定 授權三個系統群組 (`group1`、 `1002`和 `group3`) 使用 Greengrass CLI。  

```
{
  "AuthorizedPosixGroups": "group1,1002,group3"
}
```

------

## 本機日誌檔案
<a name="greengrass-cli-component-log-file"></a>

此元件使用與 [Greengrass 核](greengrass-nucleus-component.md)元件相同的日誌檔案。

------
#### [ Linux ]

```
/greengrass/v2/logs/greengrass.log
```

------
#### [ Windows ]

```
C:\greengrass\v2\logs\greengrass.log
```

------

**檢視此元件的日誌**
+ 在核心裝置上執行下列命令，以即時檢視此元件的日誌檔案。將 `/greengrass/v2`或 *C：\$1greengrass\$1v2* 取代為 AWS IoT Greengrass 根資料夾的路徑。

------
#### [ Linux ]

  ```
  sudo tail -f /greengrass/v2/logs/greengrass.log
  ```

------
#### [ Windows (PowerShell) ]

  ```
  Get-Content C:\greengrass\v2\logs\greengrass.log -Tail 10 -Wait
  ```

------

## 變更記錄
<a name="greengrass-cli-component-changelog"></a>

下表說明每個版本元件的變更。


|  **版本**  |  **變更**  | 
| --- | --- | 
|  2.16.1  |  針對 Greengrass nucleus 2.16.1 版更新版本。  | 
|  2.16.0  |  針對 Greengrass nucleus 2.16.0 版更新版本。  | 
|  2.15.1  |  針對 Greengrass nucleus 2.15.1 版更新版本。  | 
|  2.15.0  |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/greengrass/v2/developerguide/greengrass-cli-component.html)  | 
|  2.14.3  |  針對 Greengrass nucleus 2.14.3 版更新版本。  | 
|  2.14.2  |  針對 Greengrass nucleus 2.14.2 版更新版本。  | 
|  2.14.1  |  針對 Greengrass nucleus 2.14.1 版更新版本。  | 
|  2.14.0  |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/greengrass/v2/developerguide/greengrass-cli-component.html)  | 
|  2.13.0  |  針對 Greengrass nucleus 2.13.0 版更新版本。  | 
|  2.12.6  |  針對 Greengrass nucleus 2.12.6 版更新版本。  | 
|  2.12.5  |  針對 Greengrass nucleus 2.12.5 版更新版本。  | 
|  2.12.4  |  針對 Greengrass nucleus 2.12.4 版更新版本。  | 
|  2.12.3  |   此版本不再可用。此版本的改善功能可在此元件的較新版本中使用。  針對 Greengrass nucleus 2.12.3 版更新版本。  | 
|  2.12.2  |  針對 Greengrass nucleus 2.12.2 版更新版本。  | 
|  2.12.1  |  針對 Greengrass nucleus 2.12.1 版更新版本。  | 
|  2.12.0  |  針對 Greengrass nucleus 2.12.0 版更新版本。  | 
|  2.11.3  |  針對 Greengrass nucleus 2.11.3 版更新版本。  | 
|  2.11.2  |  針對 Greengrass nucleus 2.11.2 版更新版本。  | 
|  2.11.1  |  針對 Greengrass nucleus 2.11.1 版更新版本。  | 
|  2.11.0  |  <a name="changelog-cli-2.11.0"></a>[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/greengrass/v2/developerguide/greengrass-cli-component.html)  | 
|  2.10.3  |  針對 Greengrass nucleus 2.10.3 版更新版本。  | 
|  2.10.2  |  針對 Greengrass nucleus 2.10.2 版更新版本。  | 
|  2.10.1  |  針對 Greengrass nucleus 2.10.1 版更新版本。  | 
|  2.10.0  |  針對 Greengrass nucleus 2.10.0 版更新版本。  | 
|  2.9.6  |  針對 Greengrass nucleus 2.9.6 版更新版本。  | 
|  2.9.5  |  針對 Greengrass nucleus 2.9.5 版更新版本。  | 
|  2.9.4  |  針對 Greengrass nucleus 2.9.4 版更新版本。  | 
|  2.9.3  |  針對 Greengrass nucleus 2.9.3 版更新版本。  | 
|  2.9.2  |  針對 Greengrass nucleus 2.9.2 版更新版本。  | 
|  2.9.1  |  針對 Greengrass nucleus 2.9.1 版更新版本。  | 
|  2.9.0  | 針對 Greengrass nucleus 2.9.0 版更新版本。 | 
|  2.8.1  |  針對 Greengrass nucleus 2.8.1 版更新版本。  | 
|  2.8.0  | 針對 Greengrass nucleus 2.8.0 版更新版本。 | 
|  2.7.0  |  針對 Greengrass nucleus 2.7.0 版更新版本。  | 
|  2.6.0  |  <a name="changelog-greengrass-cli-2.6.0"></a>[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/greengrass/v2/developerguide/greengrass-cli-component.html)  | 
|  2.5.6  |  針對 Greengrass nucleus 2.5.6 版更新版本。  | 
|  2.5.5  |  針對 Greengrass nucleus 2.5.5 版更新版本。  | 
|  2.5.4  |  針對 Greengrass nucleus 2.5.4 版更新版本。  | 
|  2.5.3  |  針對 Greengrass nucleus 2.5.3 版更新版本。  | 
|  2.5.2  |  針對 Greengrass nucleus 2.5.2 版更新版本。  | 
|  2.5.1  |  針對 Greengrass nucleus 2.5.1 版更新版本。  | 
|  2.5.0  |  <a name="changelog-greengrass-cli-2.5.0"></a>[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/greengrass/v2/developerguide/greengrass-cli-component.html)  | 
|  2.4.0  |  <a name="changelog-greengrass-cli-2.4.0"></a>[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/greengrass/v2/developerguide/greengrass-cli-component.html)  | 
|  2.3.0  |  針對 Greengrass nucleus 2.3.0 版更新版本。  | 
|  2.2.0  |  針對 Greengrass nucleus 2.2.0 版更新版本。  | 
|  2.1.0  |  針對 Greengrass nucleus 2.1.0 版更新版本。  | 
|  2.0.5  | 針對 Greengrass nucleus 2.0.5 版更新版本。 | 
|  2.0.4  | 針對 Greengrass nucleus 2.0.4 版更新版本。 | 
|  2.0.3  |  初始版本。  |