Skip to main content

Setup

Get the SchemaX extension and CLI installed and open a project. For a full walkthrough, see Quickstart.

1. Install the extension​

For regular use — Install "SchemaX" from your editor’s marketplace:

  • VS Code — Visual Studio Marketplace (search SchemaX in Extensions, or install via the link).
  • Cursor — Extensions → search SchemaX (extension is published to Open VSX, which Cursor uses).
  • Antigravity and other Open VSX–based editors — Open VSX: SchemaX, or search SchemaX in your editor’s extension view.

2. Install the CLI (Python SDK)​

The CLI is required for schemax apply, schemax validate, schemax sql, snapshots, and CI/CD.

Install from PyPI:

pip install schemaxpy
# or: uv pip install schemaxpy

Verify:

schemax --help
Using a virtual environment

We recommend installing schemaxpy inside a virtual environment so it doesn't interfere with other Python projects.

# uv (fastest)
uv venv .venv && source .venv/bin/activate
uv pip install schemaxpy

# conda / mamba
conda create -n schemax python=3.11 && conda activate schemax
pip install schemaxpy

# standard venv
python3 -m venv .venv && source .venv/bin/activate
pip install schemaxpy

If your IDE can't find the schemax command after installing, select the correct Python interpreter: in VS Code / Cursor, open the Command Palette (Cmd+Shift+P) → Python: Select Interpreter → choose the interpreter inside your virtual environment.

3. Open a project​

  1. In VS Code, Cursor, or your editor, File → Open Folder
  2. Choose a folder that will hold your SchemaX project (e.g. a Git repo or new directory).

4. First-time project init​

  • If the folder has no .schemax/ directory, opening the designer (SchemaX: Open Designer) will create a new SchemaX project (Unity Catalog by default) with a default environment and empty state.
  • If the folder already has .schemax/project.json, SchemaX loads that project.

Next steps​

Building from source? See Development or Contributing.