1.2.1/install/index.html - third_party/github/pinterest/ktlint - Git at Google


 <!doctype html>
 <html lang="en" class="no-js">
   <head>

       <meta charset="utf-8">
       <meta name="viewport" content="width=device-width,initial-scale=1">


         <link rel="canonical" href="https://pinterest.github.io/ktlint/1.2.1/install/">


       <link rel="icon" href="../assets/images/favicon.ico">
       <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.25">


         <title>Index - Ktlint</title>


       <link rel="stylesheet" href="../assets/stylesheets/main.6543a935.min.css">


         <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">


         <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
         <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
         <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>


     <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>


   </head>


     <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="pink" data-md-color-accent="indigo">


     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
     <label class="md-overlay" for="__drawer"></label>
     <div data-md-component="skip">

     </div>
     <div data-md-component="announce">

     </div>

       <div data-md-color-scheme="default" data-md-component="outdated" hidden>

           <aside class="md-banner md-banner--warning">
             <div class="md-banner__inner md-grid md-typeset">

 You're not viewing the latest version.
 <a href="../..">
     <strong>Click here to go to latest.</strong>
 </a>

             </div>
             <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
           </aside>

       </div>


 <header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
     <a href=".." title="Ktlint" class="md-header__button md-logo" aria-label="Ktlint" data-md-component="logo">


   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>

     </a>
     <label class="md-header__button md-icon" for="__drawer">

       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
     </label>
     <div class="md-header__title" data-md-component="header-title">
       <div class="md-header__ellipsis">
         <div class="md-header__topic">
           <span class="md-ellipsis">
             Ktlint
           </span>
         </div>
         <div class="md-header__topic" data-md-component="header-topic">
           <span class="md-ellipsis">

               Index

           </span>
         </div>
       </div>
     </div>


         <form class="md-header__option" data-md-component="palette">


     <input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="pink" data-md-color-accent="indigo"  aria-label="Switch to dark mode"  type="radio" name="__palette" id="__palette_0">

       <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
       </label>


     <input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="pink" data-md-color-accent="indigo"  aria-label="Switch to light mode"  type="radio" name="__palette" id="__palette_1">

       <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
       </label>


 </form>


       <script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>


       <label class="md-header__button md-icon" for="__search">

         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
       </label>
       <div class="md-search" data-md-component="search" role="dialog">
   <label class="md-search__overlay" for="__search"></label>
   <div class="md-search__inner" role="search">
     <form class="md-search__form" name="search">
       <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
       <label class="md-search__icon md-icon" for="__search">

         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>

         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
       </label>
       <nav class="md-search__options" aria-label="Search">

           <a href="javascript:void(0)" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard data-clipboard-text="" data-md-component="search-share" tabindex="-1">

             <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7 0-.24-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91 1.61 0 2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08Z"/></svg>
           </a>

         <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">

           <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
         </button>
       </nav>

         <div class="md-search__suggest" data-md-component="search-suggest"></div>

     </form>
     <div class="md-search__output">
       <div class="md-search__scrollwrap" data-md-scrollfix>
         <div class="md-search-result" data-md-component="search-result">
           <div class="md-search-result__meta">
             Initializing search
           </div>
           <ol class="md-search-result__list" role="presentation"></ol>
         </div>
       </div>
     </div>
   </div>
 </div>


       <div class="md-header__source">
         <a href="https://github.com/pinterest/ktlint" title="Go to repository" class="md-source" data-md-component="source">
   <div class="md-source__icon md-icon">

     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg>
   </div>
   <div class="md-source__repository">
     pinterest/ktlint
   </div>
 </a>
       </div>

   </nav>


 <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
   <div class="md-grid">
     <ul class="md-tabs__list">


       <li class="md-tabs__item">
         <a href=".." class="md-tabs__link">


   Home

         </a>
       </li>


       <li class="md-tabs__item">
         <a href="setup/" class="md-tabs__link">


   Installation

         </a>
       </li>


       <li class="md-tabs__item">
         <a href="../rules/code-styles/" class="md-tabs__link">


   Rules

         </a>
       </li>


       <li class="md-tabs__item">
         <a href="../api/overview/" class="md-tabs__link">


   API

         </a>
       </li>


     <li class="md-tabs__item">
       <a href="../faq/" class="md-tabs__link">


   FAQ

       </a>
     </li>


       <li class="md-tabs__item">
         <a href="../contributing/overview/" class="md-tabs__link">


   Contributing

         </a>
       </li>


     </ul>
   </div>
 </nav>


 </header>

     <div class="md-container" data-md-component="container">


       <main class="md-main" data-md-component="main">
         <div class="md-main__inner md-grid">


               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
                 <div class="md-sidebar__scrollwrap">
                   <div class="md-sidebar__inner">


 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
     <a href=".." title="Ktlint" class="md-nav__button md-logo" aria-label="Ktlint" data-md-component="logo">


   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>

     </a>
     Ktlint
   </label>

     <div class="md-nav__source">
       <a href="https://github.com/pinterest/ktlint" title="Go to repository" class="md-source" data-md-component="source">
   <div class="md-source__icon md-icon">

     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg>
   </div>
   <div class="md-source__repository">
     pinterest/ktlint
   </div>
 </a>
     </div>

   <ul class="md-nav__list" data-md-scrollfix>


     <li class="md-nav__item md-nav__item--nested">


         <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >


           <label class="md-nav__link" for="__nav_1" id="__nav_1_label" tabindex="0">


   <span class="md-ellipsis">
     Home
   </span>


             <span class="md-nav__icon md-icon"></span>
           </label>

         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
           <label class="md-nav__title" for="__nav_1">
             <span class="md-nav__icon md-icon"></span>
             Home
           </label>
           <ul class="md-nav__list" data-md-scrollfix>


     <li class="md-nav__item">
       <a href=".." class="md-nav__link">


   <span class="md-ellipsis">
     Features
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../quick-start/" class="md-nav__link">


   <span class="md-ellipsis">
     Quick start
   </span>


       </a>
     </li>


           </ul>
         </nav>

     </li>


     <li class="md-nav__item md-nav__item--nested">


         <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >


           <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">


   <span class="md-ellipsis">
     Installation
   </span>


             <span class="md-nav__icon md-icon"></span>
           </label>

         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
           <label class="md-nav__title" for="__nav_2">
             <span class="md-nav__icon md-icon"></span>
             Installation
           </label>
           <ul class="md-nav__list" data-md-scrollfix>


     <li class="md-nav__item">
       <a href="setup/" class="md-nav__link">


   <span class="md-ellipsis">
     Recommended setup
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="cli/" class="md-nav__link">


   <span class="md-ellipsis">
     Command line
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="integrations/" class="md-nav__link">


   <span class="md-ellipsis">
     Integrations
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="snapshot-build/" class="md-nav__link">


   <span class="md-ellipsis">
     Snapshot build
   </span>


       </a>
     </li>


           </ul>
         </nav>

     </li>


     <li class="md-nav__item md-nav__item--nested">


         <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >


           <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">


   <span class="md-ellipsis">
     Rules
   </span>


             <span class="md-nav__icon md-icon"></span>
           </label>

         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
           <label class="md-nav__title" for="__nav_3">
             <span class="md-nav__icon md-icon"></span>
             Rules
           </label>
           <ul class="md-nav__list" data-md-scrollfix>


     <li class="md-nav__item">
       <a href="../rules/code-styles/" class="md-nav__link">


   <span class="md-ellipsis">
     Code styles
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../rules/standard/" class="md-nav__link">


   <span class="md-ellipsis">
     Standard rules
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../rules/experimental/" class="md-nav__link">


   <span class="md-ellipsis">
     Experimental rules
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../rules/dependencies/" class="md-nav__link">


   <span class="md-ellipsis">
     Dependencies
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../rules/configuration-ktlint/" class="md-nav__link">


   <span class="md-ellipsis">
     KtLint configuration
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../rules/configuration-intellij-idea/" class="md-nav__link">


   <span class="md-ellipsis">
     IntelliJ IDEA configuration
   </span>


       </a>
     </li>


           </ul>
         </nav>

     </li>


     <li class="md-nav__item md-nav__item--nested">


         <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >


           <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">


   <span class="md-ellipsis">
     API
   </span>


             <span class="md-nav__icon md-icon"></span>
           </label>

         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
           <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             API
           </label>
           <ul class="md-nav__list" data-md-scrollfix>


     <li class="md-nav__item">
       <a href="../api/overview/" class="md-nav__link">


   <span class="md-ellipsis">
     Overview
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../api/custom-integration/" class="md-nav__link">


   <span class="md-ellipsis">
     Custom integration
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../api/custom-rule-set/" class="md-nav__link">


   <span class="md-ellipsis">
     Custom rule set
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../api/custom-reporter/" class="md-nav__link">


   <span class="md-ellipsis">
     Custom reporter
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../api/badge/" class="md-nav__link">


   <span class="md-ellipsis">
     Badge
   </span>


       </a>
     </li>


           </ul>
         </nav>

     </li>


     <li class="md-nav__item">
       <a href="../faq/" class="md-nav__link">


   <span class="md-ellipsis">
     FAQ
   </span>


       </a>
     </li>


     <li class="md-nav__item md-nav__item--nested">


         <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >


           <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">


   <span class="md-ellipsis">
     Contributing
   </span>


             <span class="md-nav__icon md-icon"></span>
           </label>

         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
           <label class="md-nav__title" for="__nav_6">
             <span class="md-nav__icon md-icon"></span>
             Contributing
           </label>
           <ul class="md-nav__list" data-md-scrollfix>


     <li class="md-nav__item">
       <a href="../contributing/overview/" class="md-nav__link">


   <span class="md-ellipsis">
     Overview
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../contributing/guidelines/" class="md-nav__link">


   <span class="md-ellipsis">
     Guidelines
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../contributing/code-of-conduct/" class="md-nav__link">


   <span class="md-ellipsis">
     Code of conduct
   </span>


       </a>
     </li>


           </ul>
         </nav>

     </li>


   </ul>
 </nav>
                   </div>
                 </div>
               </div>


               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
                 <div class="md-sidebar__scrollwrap">
                   <div class="md-sidebar__inner">


 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">


 </nav>
                   </div>
                 </div>
               </div>


             <div class="md-content" data-md-component="content">
               <article class="md-content__inner md-typeset">


   <h1>Index</h1>


               </article>
             </div>


 <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
         </div>

       </main>

         <footer class="md-footer">

   <div class="md-footer-meta md-typeset">
     <div class="md-footer-meta__inner md-grid">
       <div class="md-copyright">


     Made with
     <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
       Material for MkDocs
     </a>

 </div>

     </div>
   </div>
 </footer>

     </div>
     <div class="md-dialog" data-md-component="dialog">
       <div class="md-dialog__inner md-typeset"></div>
     </div>


     <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.tabs.sticky", "navigation.sections", "navigation.expand", "search.suggest", "search.share"], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>


       <script src="../assets/javascripts/bundle.081f42fc.min.js"></script>


   </body>
 </html>

	<!doctype html>
	<html lang="en" class="no-js">
	<head>

	<meta charset="utf-8">
	<meta name="viewport" content="width=device-width,initial-scale=1">



	<link rel="canonical" href="https://pinterest.github.io/ktlint/1.2.1/install/">




	<link rel="icon" href="../assets/images/favicon.ico">
	<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.25">



	<title>Index - Ktlint</title>



	<link rel="stylesheet" href="../assets/stylesheets/main.6543a935.min.css">


	<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">












	<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
	<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
	<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>



	<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>






	</head>









	<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="pink" data-md-color-accent="indigo">


	<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
	<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
	<label class="md-overlay" for="__drawer"></label>
	<div data-md-component="skip">

	</div>
	<div data-md-component="announce">

	</div>

	<div data-md-color-scheme="default" data-md-component="outdated" hidden>

	<aside class="md-banner md-banner--warning">
	<div class="md-banner__inner md-grid md-typeset">

	You're not viewing the latest version.
	<a href="../..">
	<strong>Click here to go to latest.</strong>
	</a>

	</div>
	<script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
	</aside>

	</div>






	<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
	<nav class="md-header__inner md-grid" aria-label="Header">
	<a href=".." title="Ktlint" class="md-header__button md-logo" aria-label="Ktlint" data-md-component="logo">


	<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>

	</a>
	<label class="md-header__button md-icon" for="__drawer">

	<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
	</label>
	<div class="md-header__title" data-md-component="header-title">
	<div class="md-header__ellipsis">
	<div class="md-header__topic">
	<span class="md-ellipsis">
	Ktlint
	</span>
	</div>
	<div class="md-header__topic" data-md-component="header-topic">
	<span class="md-ellipsis">

	Index

	</span>
	</div>
	</div>
	</div>


	<form class="md-header__option" data-md-component="palette">




	<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="pink" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">

	<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
	<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
	</label>





	<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="pink" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">

	<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
	<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
	</label>


	</form>



	<script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>



	<label class="md-header__button md-icon" for="__search">

	<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
	</label>
	<div class="md-search" data-md-component="search" role="dialog">
	<label class="md-search__overlay" for="__search"></label>
	<div class="md-search__inner" role="search">
	<form class="md-search__form" name="search">
	<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
	<label class="md-search__icon md-icon" for="__search">

	<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>

	<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
	</label>
	<nav class="md-search__options" aria-label="Search">

	<a href="javascript:void(0)" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard data-clipboard-text="" data-md-component="search-share" tabindex="-1">

	<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7 0-.24-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91 1.61 0 2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08Z"/></svg>
	</a>

	<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">

	<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
	</button>
	</nav>

	<div class="md-search__suggest" data-md-component="search-suggest"></div>

	</form>
	<div class="md-search__output">
	<div class="md-search__scrollwrap" data-md-scrollfix>
	<div class="md-search-result" data-md-component="search-result">
	<div class="md-search-result__meta">
	Initializing search
	</div>
	<ol class="md-search-result__list" role="presentation"></ol>
	</div>
	</div>
	</div>
	</div>
	</div>


	<div class="md-header__source">
	<a href="https://github.com/pinterest/ktlint" title="Go to repository" class="md-source" data-md-component="source">
	<div class="md-source__icon md-icon">

	<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg>
	</div>
	<div class="md-source__repository">
	pinterest/ktlint
	</div>
	</a>
	</div>

	</nav>



	<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
	<div class="md-grid">
	<ul class="md-tabs__list">







	<li class="md-tabs__item">
	<a href=".." class="md-tabs__link">


	Home

	</a>
	</li>










	<li class="md-tabs__item">
	<a href="setup/" class="md-tabs__link">


	Installation

	</a>
	</li>










	<li class="md-tabs__item">
	<a href="../rules/code-styles/" class="md-tabs__link">


	Rules

	</a>
	</li>










	<li class="md-tabs__item">
	<a href="../api/overview/" class="md-tabs__link">


	API

	</a>
	</li>








	<li class="md-tabs__item">
	<a href="../faq/" class="md-tabs__link">




	FAQ

	</a>
	</li>









	<li class="md-tabs__item">
	<a href="../contributing/overview/" class="md-tabs__link">


	Contributing

	</a>
	</li>




	</ul>
	</div>
	</nav>


	</header>

	<div class="md-container" data-md-component="container">




	<main class="md-main" data-md-component="main">
	<div class="md-main__inner md-grid">



	<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
	<div class="md-sidebar__scrollwrap">
	<div class="md-sidebar__inner">






	<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
	<label class="md-nav__title" for="__drawer">
	<a href=".." title="Ktlint" class="md-nav__button md-logo" aria-label="Ktlint" data-md-component="logo">


	<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>

	</a>
	Ktlint
	</label>

	<div class="md-nav__source">
	<a href="https://github.com/pinterest/ktlint" title="Go to repository" class="md-source" data-md-component="source">
	<div class="md-source__icon md-icon">

	<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg>
	</div>
	<div class="md-source__repository">
	pinterest/ktlint
	</div>
	</a>
	</div>

	<ul class="md-nav__list" data-md-scrollfix>
















	<li class="md-nav__item md-nav__item--nested">





	<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >


	<label class="md-nav__link" for="__nav_1" id="__nav_1_label" tabindex="0">


	<span class="md-ellipsis">
	Home
	</span>


	<span class="md-nav__icon md-icon"></span>
	</label>

	<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
	<label class="md-nav__title" for="__nav_1">
	<span class="md-nav__icon md-icon"></span>
	Home
	</label>
	<ul class="md-nav__list" data-md-scrollfix>







	<li class="md-nav__item">
	<a href=".." class="md-nav__link">


	<span class="md-ellipsis">
	Features
	</span>


	</a>
	</li>










	<li class="md-nav__item">
	<a href="../quick-start/" class="md-nav__link">


	<span class="md-ellipsis">
	Quick start
	</span>


	</a>
	</li>




	</ul>
	</nav>

	</li>


















	<li class="md-nav__item md-nav__item--nested">





	<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >


	<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">


	<span class="md-ellipsis">
	Installation
	</span>


	<span class="md-nav__icon md-icon"></span>
	</label>

	<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
	<label class="md-nav__title" for="__nav_2">
	<span class="md-nav__icon md-icon"></span>
	Installation
	</label>
	<ul class="md-nav__list" data-md-scrollfix>







	<li class="md-nav__item">
	<a href="setup/" class="md-nav__link">


	<span class="md-ellipsis">
	Recommended setup
	</span>


	</a>
	</li>










	<li class="md-nav__item">
	<a href="cli/" class="md-nav__link">


	<span class="md-ellipsis">
	Command line
	</span>


	</a>
	</li>










	<li class="md-nav__item">
	<a href="integrations/" class="md-nav__link">


	<span class="md-ellipsis">
	Integrations
	</span>


	</a>
	</li>










	<li class="md-nav__item">
	<a href="snapshot-build/" class="md-nav__link">


	<span class="md-ellipsis">
	Snapshot build
	</span>


	</a>
	</li>




	</ul>
	</nav>

	</li>


















	<li class="md-nav__item md-nav__item--nested">





	<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >


	<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">


	<span class="md-ellipsis">
	Rules
	</span>


	<span class="md-nav__icon md-icon"></span>
	</label>

	<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
	<label class="md-nav__title" for="__nav_3">
	<span class="md-nav__icon md-icon"></span>
	Rules
	</label>
	<ul class="md-nav__list" data-md-scrollfix>







	<li class="md-nav__item">
	<a href="../rules/code-styles/" class="md-nav__link">


	<span class="md-ellipsis">
	Code styles
	</span>


	</a>
	</li>










	<li class="md-nav__item">
	<a href="../rules/standard/" class="md-nav__link">


	<span class="md-ellipsis">
	Standard rules
	</span>


	</a>
	</li>










	<li class="md-nav__item">
	<a href="../rules/experimental/" class="md-nav__link">


	<span class="md-ellipsis">
	Experimental rules
	</span>


	</a>
	</li>










	<li class="md-nav__item">
	<a href="../rules/dependencies/" class="md-nav__link">


	<span class="md-ellipsis">
	Dependencies
	</span>


	</a>
	</li>










	<li class="md-nav__item">
	<a href="../rules/configuration-ktlint/" class="md-nav__link">


	<span class="md-ellipsis">
	KtLint configuration
	</span>


	</a>
	</li>










	<li class="md-nav__item">
	<a href="../rules/configuration-intellij-idea/" class="md-nav__link">


	<span class="md-ellipsis">
	IntelliJ IDEA configuration
	</span>


	</a>
	</li>




	</ul>
	</nav>

	</li>


















	<li class="md-nav__item md-nav__item--nested">





	<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >


	<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">


	<span class="md-ellipsis">
	API
	</span>


	<span class="md-nav__icon md-icon"></span>
	</label>

	<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
	<label class="md-nav__title" for="__nav_4">
	<span class="md-nav__icon md-icon"></span>
	API
	</label>
	<ul class="md-nav__list" data-md-scrollfix>







	<li class="md-nav__item">
	<a href="../api/overview/" class="md-nav__link">


	<span class="md-ellipsis">
	Overview
	</span>


	</a>
	</li>










	<li class="md-nav__item">
	<a href="../api/custom-integration/" class="md-nav__link">


	<span class="md-ellipsis">
	Custom integration
	</span>


	</a>
	</li>










	<li class="md-nav__item">
	<a href="../api/custom-rule-set/" class="md-nav__link">


	<span class="md-ellipsis">
	Custom rule set
	</span>


	</a>
	</li>










	<li class="md-nav__item">
	<a href="../api/custom-reporter/" class="md-nav__link">


	<span class="md-ellipsis">
	Custom reporter
	</span>


	</a>
	</li>










	<li class="md-nav__item">
	<a href="../api/badge/" class="md-nav__link">


	<span class="md-ellipsis">
	Badge
	</span>


	</a>
	</li>




	</ul>
	</nav>

	</li>









	<li class="md-nav__item">
	<a href="../faq/" class="md-nav__link">


	<span class="md-ellipsis">
	FAQ
	</span>


	</a>
	</li>


















	<li class="md-nav__item md-nav__item--nested">





	<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >


	<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">


	<span class="md-ellipsis">
	Contributing
	</span>


	<span class="md-nav__icon md-icon"></span>
	</label>

	<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
	<label class="md-nav__title" for="__nav_6">
	<span class="md-nav__icon md-icon"></span>
	Contributing
	</label>
	<ul class="md-nav__list" data-md-scrollfix>







	<li class="md-nav__item">
	<a href="../contributing/overview/" class="md-nav__link">


	<span class="md-ellipsis">
	Overview
	</span>


	</a>
	</li>










	<li class="md-nav__item">
	<a href="../contributing/guidelines/" class="md-nav__link">


	<span class="md-ellipsis">
	Guidelines
	</span>


	</a>
	</li>










	<li class="md-nav__item">
	<a href="../contributing/code-of-conduct/" class="md-nav__link">


	<span class="md-ellipsis">
	Code of conduct
	</span>


	</a>
	</li>




	</ul>
	</nav>

	</li>



	</ul>
	</nav>
	</div>
	</div>
	</div>



	<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
	<div class="md-sidebar__scrollwrap">
	<div class="md-sidebar__inner">


	<nav class="md-nav md-nav--secondary" aria-label="Table of contents">




	</nav>
	</div>
	</div>
	</div>



	<div class="md-content" data-md-component="content">
	<article class="md-content__inner md-typeset">







	<h1>Index</h1>















	</article>
	</div>


	<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
	</div>

	</main>

	<footer class="md-footer">

	<div class="md-footer-meta md-typeset">
	<div class="md-footer-meta__inner md-grid">
	<div class="md-copyright">


	Made with
	<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
	Material for MkDocs
	</a>

	</div>

	</div>
	</div>
	</footer>

	</div>
	<div class="md-dialog" data-md-component="dialog">
	<div class="md-dialog__inner md-typeset"></div>
	</div>


	<script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.tabs.sticky", "navigation.sections", "navigation.expand", "search.suggest", "search.share"], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>


	<script src="../assets/javascripts/bundle.081f42fc.min.js"></script>


	</body>
	</html>