insync-headless(1)
NAME
insync-headless – command line interface for the Insync process
SYNOPSIS
insync-headless [OPTION] [COMMAND] [ARGUMENT]…
DESCRIPTION
Command line interface for the Insync process. Insync is an application that syncs your Drive files to your computer. It has more advanced features than Google’s official client such as multiple account support, Google Doc conversion, symlink support, and built in sharing.
OPTIONS
- -h, –help
[COMMAND] - If COMMAND is given, shows the help message for it; if not, show the basic help message.
- -v, –version
- Show program’s version number and exit.
COMMANDS
Help command
insync-headlesshelp[COMMAND]- If COMMAND is given, shows the help message for it; if not, show the basic help message.
Account commands
insync-headlessadd_account[OPTION]…- Add account to Insync.
- insync-headless get_account_information
- Show information for connected acounts.
insync-headlessmove_folderPREV_PATH NEW_PATH- Move folder to a new path.
- insync-headless remove_account
EMAIL - Remove account from Insync.
- insync-headless set_export_option
EMAIL SETTING - Set if account will download Google format files as Open Document formats (.odt), MS Office formats (.docx), or as links (.gddoc). Choices are "open-document", "ms-office", and "link".
Arguments:
-a, –auth-code AUTH_CODE – Code to authorize Insync to access your account. To get it, go to https://insynchq.com/auth and follow the prompts. If not given, Insync will open an external browser where you can login.
-p, –path PATH – Path where Insync folder for account will be placed. If not given, will default to ~/<email address>.
-e, –export-option EXPORT_OPTION – Set if account will download Google format files as Open Document formats (.odt), MS Office formats (.docx), or as links (.gddoc). Choices are "open-document", "ms-office", and "link". Defaults to "link".
-n, –no-download – Set if Insync should not download files when adding account. Files to be synced can be set later with the manage_selective_sync command.
Commands for controlling Insync
insync-headlesspause_syncing- Pause syncing.
insync-headlessquit- Stop Insync.
insync-headlessresume_syncing- Resume syncing after Insync is paused.
insync-headlessset_autostartAUTOSTART- Set autostart preference (yes/no).
- insync-headless start
[OPTION]… - Start Insync.
Options:
–no-daemon – don’t detach from the terminal, log output to stdout
—synchronous-full – sets synchronous flag of sqlite to FULL instead of the default NORMAL; makes sqlite transactions safer but causes extreme slowdown for others
File commands
insync-headlessforce_syncFULL_PATH- Force sync item.
- insync-headless get_domain_link
FULL_PATH - Get domain link for file.
- insync-headless get_file_status
FULL_PATH - Get syncing status of file.
- insync-headless get_link
FULL_PATH - Get link for file, anyone can access.
- insync-headless open_in_gdrive
FULL_PATH - Open selected file in Google Drive web interface.
- insync-headless remove_from_insync
FULL_PATH - Remove linked file/folder from Insync.
- insync-headless share
FULL_PATH - Share selected file using Insync web interface.
Ignore list commands
insync-headlessmanage_ignore_listEMAIL- Manage ignore list of account through a curses interface.
Adding an extension will NOT remove existing synced files of that type. Removing an extension, however, WILL sync existing ignored files of that type. These extensions will also be checked for folders, e.g., adding .app will ignore app bundles on Mac.
Proxy commands
insync-headlessget_proxy- Show proxy configuration.
insync-headlessset_proxyMODE [TYPE HOST PORT [USERNAME PASSWORD]]- Set proxy config.
Arguments:
MODE – Can be SYSTEM, NONE, or MANUAL. If SYSTEM or NONE, the next items are not required.
TYPE – Can be HTTP, SOCKS4, or SOCKS5.
HOST – Proxy host.
PORT – Proxy port.
USERNAME – Username for proxy authentication.
PASSWORD – Password for proxy authentication.
Selective sync commands
insync-headlessget_root_drive_filesEMAIL- Get selective sync information for root Drive files and folders of account.
- insync-headless manage_selective_sync
EMAIL - Manage selective sync settings of account through a curses interface.
- insync-headless set_selective_sync
EMAIL FILE_ID SETTING - Set selective sync preference (yes/no) of file for given email. file_id can be seen in insync-headless get_root_drive_files
Sharing commands
insync-headlessaccept_all_new_sharesEMAIL- Accept all new shares file to given account. New shares can be viewed through insync-headless get_new_shares
insync-headlessaccept_shareFILENAME EMAIL- Accept shared file to given account. New shares can be viewed through insync-headless get_new_shares
insync-headlessget_new_shares- Show new shares.
insync-headlessreject_all_new_sharesEMAIL- Reject all new shares to given account. New shares can be viewed through insync-headless get_new_shares
insync-headlessreject_shareFILENAME EMAIL- Reject shared file to given account. New shares can be viewed through insync-headless get_new_shares
Status commands
insync-headlessget_actions_required- Show required actions.
insync-headlessget_errors- Show error messages.
insync-headlessget_recent_changes- Show 20 most recent changes.
insync-headlessget_status- Show syncing status.
insync-headlessget_sync_progress- Show progress of files being downloaded/uploaded and how many files are queued.
insync-headlessretry_errors- Retry all errors.
BUGS
Please report bugs to support [at] insynchq.com.
How-to guides: <https://help.insynchq.com>.
Support forums: <https://forums.insynchq.com>.
AUTHOR
Created by the Insync team.
SEE ALSO
insync(1)