Setup

Installation

From PyPI

pip install clone-xs

Using a virtual environment

venv

python -m venv .venv
source .venv/bin/activate
pip install clone-xs

conda

conda create -n clxs python=3.13
conda activate clxs
pip install clone-xs

uv

uv venv
source .venv/bin/activate
uv pip install clone-xs

From source (development)

git clone https://github.com/viral0216/clone-xs.git
cd clone-xs
pip install -e ".[dev]"

Verify

clxs --help

Dependencies

Package	Purpose
databricks-sdk	Databricks REST API client
pyyaml	YAML config file parsing
python-dotenv	.env file loading

Shell completions

Generate shell completions for tab-completion of commands and flags:

# Bash
clxs completion bash > ~/.local/share/bash-completion/completions/clxs

# Zsh
clxs completion zsh > ~/.zfunc/_clxs

# Fish
clxs completion fish > ~/.config/fish/completions/clxs.fish

Project initialisation

Create a default config file to get started:

clxs init

This generates config/clone_config.yaml with documented defaults:

source_catalog: ""
destination_catalog: ""
sql_warehouse_id: ""
clone_type: "DEEP"          # DEEP or SHALLOW
load_type: "FULL"           # FULL or INCREMENTAL
max_workers: 4
copy_permissions: true
copy_ownership: true
copy_tags: true
exclude_schemas:
  - "information_schema"
  - "default"

Databricks notebook deployment

Clone Catalog can also run inside Databricks notebooks. See Notebooks for wheel installation and repo-based import options.