文档

安装CLI

更新时间:

日志服务命令行工具CLI支持大部分日志服务功能操作,包括Project管理、Logstore管理、日志查询、自动分页和多账户跨域复制等场景。本文介绍如何安装日志服务命令行工具CLI。

安装之前必读

日志服务CLI工具基于Python开发,需要安装Python。安装方法,请参见Python官网

说明项

说明

当前CLI版本

0.2.7

说明

您可以执行安装命令完成CLI工具的升级。建议您升级到最新版本。

工具源码

Aliyun Log CLI

支持Python版本

Python 2.6、2.7、3.3、3.4、3.5、3.6、3.7、3.8和3.9。

支持操作系统

Windows、Linux和macOS。

依赖组件

安装Python完成后,建议您使用pip install package_name命令优先安装以下依赖组件。

  • docopt

  • aliyun-log-python-sdk

  • jmespath

  • aliyun-python-sdk-core

  • aliyun-python-sdk-sts

  • requests

步骤一:配置Python环境变量

重要

配置环境变量,是为了保证aliyunlog的命令可以正常运行。环境变量配置完成之后,为确保新的设置被正确应用,您可能需要重启相关的开发工具(IDE等)或服务。

在Linux和macOS系统环境变量中配置Python环境变量

  1. 创建.bash_profile文件。

    说明

    如果是第一次设置环境变量,可以使用touch ~/.bash_profile创建一个配置文件,如果已经存在配置文件,则使用vim ~/.bash_profile命令直接编辑文件。

    touch ~/.bash_profile
    vim ~/.bash_profile
  2. 查看Python安装目录。

    which python3
  3. 配置.bash_profile文件

    export PATH=$PATH:/usr/local/python3/bin
  4. 使用.bash_profile文件

    # 使配置文件生效
    source ~/.bash_profile

在Windows系统环境变量中配置Python环境变量

以下为Windows 10中通过图形用户界面设置环境变量的步骤。

  1. 查找Python安装路径。

    在桌面右键单击此电脑,选择属性>高级系统设置>环境变量>用户变量 > Path可以查到Python的环境变量。

  2. 增加Python环境变量。

    在桌面右键单击此电脑,选择属性>高级系统设置>环境变量>用户变量 > Path > 新建例如步骤1查找的变量是D:\dev\python\python37\,需要添加的变量是D:\dev\python\python37\bin

步骤二:安装CLI

在Linux系统安装CLI

  1. 登录Linux服务器。

  2. 执行如下命令安装CLI。

    pip3 install aliyun-log-python-sdk aliyun-log-cli -U --no-cache
  3. 验证安装结果。

    运行命令如下:

    aliyunlog --version

    若有对应的命令提示输出,则安装成功。

在Windows系统安装CLI

  1. 登录Windows服务器。

  2. 打开Windows命令行。

    如果您已经设置Python环境变量,可以直接执行后续命令进行安装。若提示pip3命令无法识别,则说明您未配置Python环境变量,此时您可以使用cd进入Python安装路径后,再执行安装命令。

  3. 执行如下安装命令安装CLI。

    pip3 install aliyun-log-python-sdk aliyun-log-cli -U --no-cache
  4. 验证安装结果。

    运行命令如下:

    aliyunlog --version

    若有对应的命令提示输出,则安装成功。

在mac OS系统安装CLI

推荐使用pip3安装日志服务命令工具CLI,参考命令如下:

pip3 install -U aliyun-log-cli --no-cache

如何升级CLI

您可以执行安装命令完成CLI工具的升级。建议您升级到最新版本。

如何卸载CLI

如果您不需要继续使用CLI,您可以将其卸载。执行命令如下:

pip3 uninstall aliyun-log-cli