Files
mtc-project-sync-script/MANUAL

71 lines
2.1 KiB
Plaintext

SYNC-PROJECT(1) Project Sync Toolkit SYNC-PROJECT(1)
NAME
sync-project.sh - Sync projects between remote servers and local machine
SYNOPSIS
sync-project.sh [OPTIONS]
DESCRIPTION
Downloads a project from a remote server and optionally generates helper
scripts for ongoing synchronization. Uses tar for initial sync and rsync
for subsequent syncs.
OPTIONS
-h, --help
Display this help and exit.
--files-only
Quick sync mode. Downloads files only, excluding node_modules and
vendor directories. Does not create helper scripts, sftp.json, or
upload lazygit.
--sftp-only
Setup mode for SFTP workflow. Creates helper scripts but skips
lazygit upload and .gitignore modifications.
MODES
Default mode:
- Downloads all project files
- Creates .vscode/sftp.json
- Generates all helper scripts
- Uploads lazygit to server
- Updates .gitignore
--sftp-only mode:
- Downloads all project files
- Creates .vscode/sftp.json
- Generates: local-remote.sh, remote-local.sh, sftp-watch.sh, ssh.sh
- No lazygit, no .gitignore updates
--files-only mode:
- Downloads project files (excludes node_modules, vendor)
- No helper scripts
- No configuration files
EXAMPLES
Full setup with all scripts:
./sync-project.sh
Quick file sync only:
./sync-project.sh --files-only
SFTP workflow without git tools:
./sync-project.sh --sftp-only
GENERATED SCRIPTS
remote-local.sh Pull files from server
local-remote.sh Push files to server
ssh.sh SSH with --db, --git, --todo flags
sftp-watch.sh Continuous sync with watchexec
watch-build.sh Build and deploy automation
split-conflicts.sh Git conflict resolver
REQUIREMENTS
sshpass, rsync, tar, ssh/scp
Optional: watchexec (for watch scripts)
FILES
.sync-credentials Pre-defined config (optional)
.vscode/sftp.json VS Code SFTP config (generated)