Clone a Project - Quick Start
This guide will help you get started with an existing Rill project by cloning it from a repository and setting it up locally.
Prerequisites
Before you begin, make sure you have:
- Rill CLI installed (Installation Guide)
curl https://rill.sh | sh
- Access to the Rill Project
Step 1: Clone the Repository
Depending on if your project is synced to GitHub or not, select the correct clone method. If you are unsure, please see the Status page in the project.
From GitHub

# Clone the repository
git clone https://github.com/username/rill-project.git #replace username and rill-project with your actual URL
cd <project-name>
Using Rill CLI

# Clone from Rill
rill project clone <project-name>
Step 2: Explore the Project Structure
A typical Rill project contains:
<project-name>/
├── rill.yaml # Project configuration
├── sources/ # Data source definitions
│ ├── database.yaml # Database connections
│ ├── api.yaml # API endpoints
│ └── files.yaml # File-based sources
├── models/ # SQL transformations
│ ├── staging/ # Staging models
│ ├── marts/ # Business logic models
│ └── metrics/ # Metric definitions
├── dashboards/ # Dashboard configurations
│ └── main_dashboard.yaml
├── alerts/ # Alert definitions