Skip to content

Commit

Permalink
Release v0.4.0
Browse files Browse the repository at this point in the history
  • Loading branch information
GrahamCampbell authored Mar 21, 2020
1 parent 5e9dd75 commit 630d55a
Showing 1 changed file with 29 additions and 3 deletions.
32 changes: 29 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,45 @@
The StyleCI CLI Tool requires [PHP](https://php.net) 7.2.5 or higher. Download `styleci.phar` from the [releases page](https://github.com/StyleCI/CLI/releases/latest), and put it in your favourite location for bin files (alongside composer), removing the `.phar` from the filename.

```bash
$ curl -SsLo styleci.phar https://github.com/StyleCI/CLI/releases/download/v0.3.1/styleci.phar \
$ curl -SsLo styleci.phar https://github.com/StyleCI/CLI/releases/download/v0.4.0/styleci.phar \
&& chmod +x styleci.phar && sudo mv styleci.phar /usr/local/bin/styleci
```

## Usage

Now, you can analyze any local copy of a repo enabled in StyleCI, from the console!

### StyleCI for GitHub

```bash
$ STYLECI_GITHUB_API_KEY=YOUR-API-KEY-GOES-HERE styleci analyze
```

> Your API key is available at https://github.styleci.io/profile.
### StyleCI for GitLab

```bash
$ STYLECI_API_KEY=YOUR-API-KEY-GOES-HERE styleci analyze
$ STYLECI_GITLAB_API_KEY=YOUR-API-KEY-GOES-HERE styleci analyze
```

You can optionally pass a directory to analyze, otherwise, the current working directory will be used.
> Your API key is available at https://gitlab.styleci.io/profile.
### StyleCI for Bitbucket

```bash
$ STYLECI_BITBUCKET_API_KEY=YOUR-API-KEY-GOES-HERE styleci analyze
```

> Your API key is available at https://bitbucket.styleci.io/profile.
### API Key Storage

You may want to set this environment variable more permanent in practice, such as by exporting it in your `~/.zprofile` file.

### Advanced Usage

You can optionally pass a directory to analyze, otherwise, the current working directory will be used. Moreover, we support analyzing only the changed files, performing a "dry run" without touching your files, and more:

```
Usage:
Expand Down

0 comments on commit 630d55a

Please sign in to comment.