Skip to content

Latest commit

 

History

History
115 lines (82 loc) · 4.63 KB

README.md

File metadata and controls

115 lines (82 loc) · 4.63 KB
Raw

dropboxignore

dropboxignore-logo

It's all about the missing .dropboxignore file.

Documentation Status dropboxignore Google code style Installation counter

Installation • Getting started • CLI • How to Contribute

This CLI shell script aims to take advantage of glob patterns and existing .gitignore files in order to exclude specific folders and files from dropbox sync. The shell script uses this recent approach to ignore folders and files.

Installation

Using the kickstart script

dropboxignore is installed by running one of the following commands in your terminal. You can install this via the command-line with either curl, wget or another similar tool. attr and git should be installed on your system, as well as Homebrew if you are on macOS.

Method Command
curl sudo sh -c "$(curl -fsSL https://rb.gy/g4plll)" c
wget sudo sh -c "$(wget -qO- https://rb.gy/g4plll)" w

Worried about mysterious shorted urls like? Take a look at the installation script here: https://rb.gy/g4plll --> https://raw.githubusercontent.com/sp1thas/dropboxignore/master/src/utils/install.sh)

Snap

Get it from the Snap Store

$ snap install dropboxignore

Flatpak

$ flatpak install flathub me.simakis.dropboxignore

From source

$ git clone https://github.com/sp1thas/dropboxignore.git
$ cd dropboxignore
$ make test  # optional step, Docker and docker-compose should be installed
$ sudo make install

Uninstall

$ sudo make uninstall

Getting 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 :material-dropbox: 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 .

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).

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

Long story short

Here you can find some of the most common cases that dropboxignore could be useful.

CLI

Here you will find extensive documentation about the dropboxignore command line interface.

How to contribute

If you want to contribute, read the contribution guideline for further details.

*Logo is based on papirus-icon-theme