Repository files navigation

https://www.flycheck.org

Modern on-the-fly syntax checking extension for GNU Emacs.Try it!

Flycheck is available for installation withpackage.el onNonGNUELPA,MELPAStable andMELPA.

You can install Flycheck with the following command:

M-xpackage-install[RET]flycheck[RET]

Finally add this to your Emacs config:

(global-flycheck-mode+1)

Alternatively, if you're intouse-package you can do the following:

(use-package flycheck:ensuret:config  (add-hook'after-init-hook#'global-flycheck-mode))

Now you can start using any of thebundled checkers or install additional checkers.

For a more gentle introduction read theInstallation instructions and gothroughQuickstart guide.

Please ask questions about Flycheck onStack Exchange or in ourGitter chat, and report bugs to ourissue tracker.

We welcome all kinds of contributions, whether you write patches, open pullrequests, write documentation, help others with Flycheck issues, or just tellother people about your experiences with Flycheck. Please take a look at ourContributor’s Guide for help and guidance about contributing toFlycheck.

You can support financially the development of Flycheck and related packagesvia:

• Open Collective
• GitHub Sponsors
• Patreon
• PayPal

Become a sponsor and get your logo on our README on Github with a link to yoursite. [Become a sponsor]

We strive to create a safe, friendly and welcoming environment in the Flycheckcommunity and have aCode of Conduct that defines acceptable and welcomebehaviour as well as sanctions for violations. All contributors and allparticipants are expected to follow it, on Github, Gitter, Emacs.SX or any otherplace that’s part of Flycheck’s broader community.

Flycheck is free software: you can redistribute it and/or modify it under theterms of theGNU General Public License as published by the FreeSoftware Foundation, either version 3 of the License, or (at your option) anylater version.

Flycheck is distributed in the hope that it will be useful, but WITHOUT ANYWARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR APARTICULAR PURPOSE. See theGNU General Public License for moredetails.