What is a .kiteignore file and how does it work?

The .kiteignore specification is Kite's way of allowing our users to have fine grained control over which files Kite uploads to our servers.

.kiteignore files have the same syntax and semantics as .gitignore files (link) except that Kite does not support the ! syntax. If these lines are included in a .kiteignore file they are ignored.

.kiteignore files must be placed in a whitelisted directory, and they apply to all files and directories that are children of the directory that contains the .kiteignore file.

Example

Say I have the following directories whitelisted:

  • /Users/sam
  • /Users/mike
  • /Users

and I place the following lines in a .kiteignore file in /Users:

*secrets*
*sam*

The first rule means that any file path that contains the word "secrets" will be ignored, e.g:

  • /Users/mike/secrets/
  • /Users/mike/python/secrets.py

etc...

The second rule means that any file path that contains the word "sam" will be ignored, e.g:

  • any files that are children of /Users/sam
  • /Users/mike/shared/sam

etc...