qlqz-git-sync-cli

A CLI tool to sync specified directories and files from a git repository to local.

Features

• Sync specified directories from a git repository
• Sync specified files from a git repository
• Support configuration file for directory and file list
• Skip existing files (keep local files unchanged)
• Easy to use with npx

Installation

Global Installation

npm install -g qlqz-git-sync-cli

Use with npx

npx qlqz-git-sync-cli sync --repo <git-repo-url> --dirs <directories>

Usage

Basic Usage

Sync specified directories from a git repository:

qlqz-git-sync-cli sync --repo https://github.com/example/repo.git --dirs src,public

Sync specified files from a git repository:

qlqz-git-sync-cli sync --repo https://github.com/example/repo.git --files package.json,README.md,.gitignore

Sync both directories and files:

qlqz-git-sync-cli sync --repo https://github.com/example/repo.git --dirs src,public --files package.json,README.md

Sync from a specific branch:

qlqz-git-sync-cli sync --repo https://github.com/example/repo.git --branch develop --dirs src,public

Sync from a local directory:

qlqz-git-sync-cli sync --path D:\path\to\local\directory --dirs src,public

Use Configuration File

New Configuration Structure (Recommended)

Create a configuration file (e.g., sync-config.json):

{
  "branch": "main",
  "files": {
    "sync": [
      "src/vendors/",
      "config.json"
    ],
    "create": [
      "public/config/",
      "src/assets/",
      "package.json",
      "README.md"
    ]
  }
}

• sync: Items to sync with replacement (always replace files if changed)
• create: Items to create only if they don't exist (skip existing files)
• Directory identification: Items ending with / are treated as directories
• File identification: Items not ending with / are treated as files

Legacy Configuration Structure (Backward Compatible)

{
  "dirs": ["src", "public", "config"],
  "files": ["package.json", "README.md", ".gitignore"]
}

Then run:

qlqz-git-sync-cli sync --repo https://github.com/example/repo.git --config sync-config.json

Command Options

Usage: qlqz-git-sync-cli sync [options]

Sync directories and files from git repository or local directory

Options:
  -r, --repo <url>     Git repository URL
  -p, --path <path>    Local directory path
  -c, --config <path>  Configuration file path
  -d, --dirs <dirs>    Directories to sync (comma-separated)
  -f, --files <files>  Files to sync (comma-separated)
  -b, --branch <branch> Git branch to sync from
  -h, --help           display help for command

How It Works

1. Creates a temporary directory
2. Clones the specified git repository into the temporary directory
3. Copies the specified directories from the temporary repository to the current directory
4. Skips existing files (keeps local files unchanged)
5. Cleans up the temporary directory

Example

Sync the src and public directories from a git repository:

npx qlqz-git-sync-cli sync --repo https://github.com/example/repo.git --dirs src,public

This will:

1. Clone the repository to a temporary directory
2. Copy the src directory and its contents to the current directory
3. Copy the public directory and its contents to the current directory
4. Skip any files that already exist in the current directory

License

ISC