{"id":13856685,"url":"https://github.com/SamSchott/maestral","last_synced_at":"2025-07-13T19:32:17.824Z","repository":{"id":37794520,"uuid":"159194638","full_name":"samschott/maestral","owner":"samschott","description":"Open-source Dropbox client for macOS and Linux","archived":false,"fork":false,"pushed_at":"2024-10-28T18:08:02.000Z","size":130212,"stargazers_count":3116,"open_issues_count":126,"forks_count":64,"subscribers_count":28,"default_branch":"main","last_synced_at":"2024-11-11T14:40:42.729Z","etag":null,"topics":["dropbox-client","dropbox-sync","linux","macos","python"],"latest_commit_sha":null,"homepage":"https://maestral.app","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/samschott.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"SamSchott"}},"created_at":"2018-11-26T15:52:49.000Z","updated_at":"2024-11-10T21:15:37.000Z","dependencies_parsed_at":"2023-02-12T17:20:15.387Z","dependency_job_id":"e8b8be8b-fd57-434a-8e8c-8359921d2ebb","html_url":"https://github.com/samschott/maestral","commit_stats":{"total_commits":5200,"total_committers":20,"mean_commits":260.0,"dds":"0.12076923076923074","last_synced_commit":"296fa4f61e83d0bcb4a30cbf1cf0143e48beeb4b"},"previous_names":["samschott/maestral-dropbox"],"tags_count":168,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samschott%2Fmaestral","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samschott%2Fmaestral/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samschott%2Fmaestral/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samschott%2Fmaestral/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/samschott","download_url":"https://codeload.github.com/samschott/maestral/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225912214,"owners_count":17544124,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dropbox-client","dropbox-sync","linux","macos","python"],"created_at":"2024-08-05T03:01:08.946Z","updated_at":"2024-11-22T14:30:31.965Z","avatar_url":"https://github.com/samschott.png","language":"Python","funding_links":["https://github.com/sponsors/SamSchott"],"categories":["Python","Mac/iOS"],"sub_categories":["Containers"],"readme":"[![PyPi Release](https://img.shields.io/pypi/v/maestral.svg)](https://pypi.org/project/maestral/)\n[![Pyversions](https://img.shields.io/pypi/pyversions/maestral.svg)](https://pypi.org/pypi/maestral/)\n[![Documentation Status](https://readthedocs.org/projects/maestral/badge/?version=latest)](https://maestral.readthedocs.io/en/latest/?badge=latest)\n[![codecov](https://codecov.io/gh/SamSchott/maestral/branch/master/graph/badge.svg?token=V0C7IQ1MAU)](https://codecov.io/gh/SamSchott/maestral)\n\n# Maestral \u003cimg src=\"https://raw.githubusercontent.com/SamSchott/maestral/master/src/maestral/resources/maestral.png\" align=\"right\" title=\"Maestral\" width=\"110\" height=\"110\"\u003e\n\nA light-weight and open-source Dropbox client for macOS and Linux.\n\n## About\n\nMaestral is an open-source Dropbox client written in Python. The project's main goal is to\nprovide a client for platforms and file systems that are no longer directly supported by\nDropbox.\n\nMaestral currently does not support Dropbox Paper, the management of Dropbox teams, and\nthe management of shared folder settings. If you need any of this functionality, please\nuse the Dropbox website or the official client. Maestral does support syncing\nmultiple Dropbox accounts and excluding local files from sync with a \".mignore\" file.\n\nThe focus on \"simple\" file syncing does come with advantages: on macOS, the Maestral App\nbundle is significantly smaller than the official Dropbox app and uses less memory. The\nexact memory usage will depend on the size of your synced Dropbox folder and can be further\nreduced when running Maestral without a GUI.\n\nMaestral uses the public Dropbox API which, unlike the official client, does not support\ntransferring only those parts of a file which changed (\"binary diff\"). Maestral may\ntherefore use more bandwidth that the official client. However, it will avoid uploading\nor downloading a file if it already exists with the same content locally or in the cloud.\n\n## Warning\n\n- Never sync a local folder with both the official Dropbox client and Maestral at the same\n  time.\n- Network drives and some external hard drives are not supported as locations for the\n  Dropbox folder.\n\n## Installation\n\nAn app bundle is provided for macOS Catalina and higher and can be downloaded from the\nReleases tab. This app Bundle is also package as a Homebrew cask.\n\nOn other platforms, you can download and install Maestral as a Python package from PyPI or\nas a Docker image from Docker Hub.\n\nFor more detailed information on the installation, setup and system requirements, please\ncheck the [documentation](https://maestral.app/docs/installation).\n\n### Homebrew\n\nThe official Maestral releases are also available as Homebrew casks. If you have\n[Homebrew](https://brew.sh) on your system, you can install using:\n\n```console\n$ brew install maestral\n```\n\n### Python package using PyPI\n\nIs is recommended to install Maestral inside a virtual environment as follows:\n\n```console\n$ python3 -m venv maestral-venv\n$ source maestral-venv/bin/activate\n(maestral-venv)$ python3 -m pip install --upgrade maestral\n```\n\nIf you intend to use the graphical user interface, you also need to specify the GUI option\nduring installation or upgrade. This will install the `maestral-qt` frontend and `PyQt5`\non Linux and `maestral-cocoa` on macOS:\n\n```console\n(maestral-venv)$ python3 -m pip install --upgrade 'maestral[gui]'\n```\n\n### Docker image\n\nA Docker image is available for x86, arm/v7 (32bit) and arm64 platforms and can be\ninstalled with:\n\n```colsole\n$ docker pull maestraldbx/maestral\n```\n\n## Usage\n\nRun `maestral gui` in the command line (or open the Maestral app on macOS) to start\nMaestral with a graphical user interface. On its first run, Maestral will guide you\nthrough linking and configuring your Dropbox and will then start syncing.\n\n\u003cimg src=\"https://raw.githubusercontent.com/SamSchott/maestral-dropbox/master/screenshots/macOS_dark.png\" alt=\"screenshot macOS\" width=\"840\"/\u003e\n\u003cimg src=\"https://raw.githubusercontent.com/SamSchott/maestral-dropbox/master/screenshots/Ubuntu.png\" alt=\"screenshot Fedora\" width=\"840\"/\u003e\n\n### Command line usage\n\nAfter installation, Maestral will be available as a command line script by typing\n`maestral` in the command prompt. Type `maestral --help` to get a full list of available\ncommands. The most important are:\n\n- `maestral gui`: Starts the Maestral GUI. Creates a sync daemon if not already running.\n- `maestral start|stop`: Starts or stops the Maestral sync daemon.\n- `maestral pause|resume`: Pauses or resumes syncing.\n- `maestral autostart -Y|-N`: Sets the daemon to start on log in.\n- `maestral status`: Gets the current status of Maestral.\n- `maestral filestatus LOCAL_PATH`: Gets the sync status of an individual file or folder.\n- `maestral excluded add|remove|list`: Command group to manage excluded folders.\n- `maestral ls DROPBOX_PATH`: Lists the contents of a directory on Dropbox.\n- `maestral notify snooze N`: Snoozes desktop notifications for N minutes.\n\nMaestral supports syncing multiple Dropbox accounts by running multiple instances\nwith different configuration files. This needs to be configured from the command\nline by passing the option `--config-name` to `maestral start` or `maestral gui`.\nMaestral will then select an existing config with the given name or create a new one.\nFor example:\n\n```console\n$ maestral start --config-name=\"personal\"\n$ maestral start --config-name=\"work\"\n```\n\nThis will start two instances of Maestral, syncing a private and a work account,\nrespectively. Configs will be automatically cleared when unlinking an account. You can\nlist all currently linked accounts with `maestral config-files`. The above setup for\nexample will return the following on macOS:\n\n```console\n$ maestral config-files\n\nConfig name  Account          Path\nmaestral     user@gmail.com   ~/Library/Application Support/maestral/maestral.ini\nprivate      user@mycorp.org  ~/Library/Application Support/maestral/private.ini\n```\n\nBy default, the Dropbox folder names will contain the capitalised config-name in braces.\nIn the above case, this will be \"Dropbox (Personal)\" and \"Dropbox (Work)\".\n\nA full documentation of the CLI is available on the\n[website](https://maestral.app/cli).\n\n## Contribute\n\nThere are multiple topics that could use your help. Some of them are easy, such as adding\nnew CLI commands, others require more experience, such as packaging for non-macOS\nplatforms. Look out for issues marked with \"good first issue\" or \"help wanted\".\n\nRelevant resources are:\n\n- [Maestral API docs](https://maestral.readthedocs.io)\n- [Dropbox API docs](https://www.dropbox.com/developers/documentation/http/documentation)\n- [Dropbox Python SDK docs](https://dropbox-sdk-python.readthedocs.io/en/latest/)\n\n[CONTRIBUTING.md](CONTRIBUTING.md) contains detailed information on the expected code\nstyle and test format.\n\nIf you are using the macOS app bundle, please consider sponsoring the project with £1 per\nmonth to offset the cost of an Apple Developer account to sign and notarize the bundle.\n\n## System requirements\n\n- macOS 10.15 Catalina or higher or Linux\n- Python 3.7 or higher\n- For the system tray icon on Linux:\n  - [gnome-shell-extension-appindicator](https://github.com/ubuntu/gnome-shell-extension-appindicator)\n    on Gnome 3.26 and higher\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSamSchott%2Fmaestral","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FSamSchott%2Fmaestral","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSamSchott%2Fmaestral/lists"}