README

安装

StyleCI CLI工具需要PHP 7.4或更高版本，可以通过直接下载phar文件或使用Composer进行安装。

下载Phar文件

全局安装

$ curl -SsLo styleci.phar https://github.com/StyleCI/CLI/releases/download/v1.5.1/styleci.phar \
    && chmod +x styleci.phar && sudo mv styleci.phar /usr/local/bin/styleci

使用Composer安装

本地安装

$ composer require styleci/cli:^1.5 --dev

全局安装

$ composer global require styleci/cli:^1.5

首次设置

首次使用该工具时，您可能需要输入您的StyleCI API密钥。您可以使用styleci config命令来完成此操作，该命令将密钥存储在~/.styleci/config.json中，就像Composer存储密钥一样。

GitHub上的StyleCI

styleci config auth.github YOUR-API-KEY-GOES-HERE

您的API密钥可在https://github.styleci.io/profile找到。

GitLab上的StyleCI

styleci config auth.gitlab YOUR-API-KEY-GOES-HERE

您的API密钥可在https://gitlab.styleci.io/profile找到。

Bitbucket上的StyleCI

styleci config auth.bitbucket YOUR-API-KEY-GOES-HERE

您的API密钥可在https://bitbucket.styleci.io/profile找到。

使用方法

现在，您可以从控制台分析任何在StyleCI中启用的仓库的本地副本！只需运行

$ styleci

StyleCI将分析您的当前目录。

环境变量

如果您选择不使用首次设置配置，或者想要临时覆盖存储的密钥，可以通过设置环境变量来完成。

GitHub上的StyleCI

$ STYLECI_GITHUB_API_KEY=YOUR-API-KEY-GOES-HERE styleci

GitLab上的StyleCI

$ STYLECI_GITLAB_API_KEY=YOUR-API-KEY-GOES-HERE styleci

Bitbucket上的StyleCI

$ STYLECI_BITBUCKET_API_KEY=YOUR-API-KEY-GOES-HERE styleci

高级使用

您可以选择传递一个要分析的目录，否则将使用当前工作目录。此外，我们支持仅分析更改的文件，执行“dry run”而不更改您的文件，等等。

Usage:
  analyze [options] [--] [<directory>]

Arguments:
  directory

Options:
  -c, --only-changed
  -d, --dry-run
  -g, --git-binary=GIT-BINARY
  -r, --remote-name=REMOTE-NAME
  -h, --help                     Display this help message
  -q, --quiet                    Do not output any message
  -V, --version                  Display this application version
      --ansi                     Force ANSI output
      --no-ansi                  Disable ANSI output
  -n, --no-interaction           Do not ask any interactive question
  -v|vv|vvv, --verbose           Increase the verbosity of messages

请注意，styleci是styleci analyze的简称。如果您想要分析具有相对路径config的目录或其他任何命令名称，这将很重要。您需要写入styleci analyze config才能使用此类<directory>参数。

许可协议

本工具遵循Apache License 2.0许可协议。