Skip to content

Get started

dropboxignore is a CLI tool which supports a collection of commands in order to make your life easier when it comes to exclude files or/and folders from dropbox sync. Below you will find some common usecases.

A typical workflow

A common workflow could be the following:

  1. Automatically generate .dropboxignore files based on existing .gitignore files.
  2. Manually update or create .dropboxignore files (Optional).
  3. Ignore matched files based on .dropboxignore files.

and you can run this flow by running the following command:

$ dropboxignore genupi .

Important warning

In order to prevent unpleasant data losses, exception patterns are not supported. Both .gitignore and .dropboxignore files with at least one exceptional pattern will be bypassed (for further details: #3).

Keep in mind

Automatic generation of .dropboxignore files is an optional step, therefore, may not be a necessary action for your case.

Long story short

Below you will find some of the most common cases that dropboxignore could be useful.

node_modules_meme

$ dropboxignore ignore ./node_modules

python_venv

$ dropboxignore ignore ./venv
$ dropboxignore ignore *.pyc

$ dropboxignore ignore *.aux
$ dropboxignore ignore .idea/
$ dropboxignore ignore .vscode/