StyleCI

The StyleCI Docs

Welcome to the StyleCI docs. You'll find comprehensive guides and documentation to help you start working with StyleCI as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    Documentation

Getting Started

This page will help you get started with StyleCI. You'll be up and running in a jiffy!

Welcome to StyleCI - The PHP Coding Style Service!

StyleCI provides checks for both your open and closed source repos. By analyzing every push or pull request made on your repo, StyleCI ensures that your code is always written against the standards you want it to be.

Connect with GitHub

To get started, click the Login with GitHub button on our homepage. You'll be redirected to GitHub where you need to confirm that we're able to access the following:

  • Access your name (and GitHub username)
  • Access your email address
  • Access any teams and organisations you're a part of
  • Write a new webhook on any repo that you activate

GitHub Controls Our Access

Note that you can see the exact details of our access through your GitHub account page. You can also see whenever we access your repo using git because GitHub allows you to see when our deploy key was last used.

Third Party Access Control

Be sure to allow StyleCI access to any repositories that require third party access to be approved.

Congratulations, you are now signed in to StyleCI! You'll soon receive an email from us with confirmation of your new account.

Private Repo Support

StyleCI is free for all open source projects. We offer various plans for private repositories.

You can upgrade or downgrade your plan on your account page, https://styleci.io/account#plan. If you have a coupon code for StyleCI then you can apply it when you upgrade to a paid plan.

If you're not interested in a paid plan, that's totally fine, but you may want to know that you can still access private repos from the open source plan if someone else in your organization is subscribed to a paid plan that supports private organizations. To view these repos, you need to visit the the profile tab, https://styleci.io/account#plan, and under the Access heading, change this to private.

This will allow us to read your private repo memberships, after you've approved this change on GitHub.

VAT ID

If you are using StyleCI on behalf of a business, please provide us with your VAT ID.
This can be done via the account page.

Your Repos

All you repos are listed in the repos tab of your account page. You can enable repos you want us to analyse here. After enabling a repo, you can visit it by clicking the "Show Analyses" button. At this point, you have the option to modify it's settings, or just go ahead, and press that "Analyse Now" button. You can select the branch you want to look at through the branch select drop down on the left. For information about configuration, please check out the configuration section of our docs.

Finally, you can view all the repos enabled on our system by clicking on our badge. That will take you to our homepage where you will find summaries of all your repos' status.


What's Next

Configuration

Getting Started

This page will help you get started with StyleCI. You'll be up and running in a jiffy!