rill-rillyaml

Configure rill.yaml project settings, OLAP connectors, environment variables, and path management.

47|9|Updated May 17, 2023
One-click install
npx skills add https://github.com/rilldata/rill-examples --skill rill-rillyaml
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: rill-rillyaml
Source: https://github.com/rilldata/rill-examples/tree/main/medicaid-provider-spending/.claude/skills/rill-rillyaml
Command: npx skills add https://github.com/rilldata/rill-examples --skill rill-rillyaml

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill demystifies the rill.yaml configuration file, enabling users to effectively define project-wide settings, manage data connectors, and configure environment variables for Rill projects.

Core Features & Use Cases

  • Project Configuration: Understand and set project metadata like display_name and description.
  • OLAP Connector Setup: Configure the default OLAP database for your project (e.g., DuckDB, ClickHouse).
  • Environment Variables & Mock Users: Define environment variables and mock users for testing security policies.
  • Resource Defaults: Set project-wide defaults for models, metrics views, and explores.
  • Path Management: Control which files are parsed or exposed using ignore_paths and public_paths.
  • Use Case: You're starting a new Rill project and need to set up your default database connection, define some environment variables for data sources, and configure default time ranges for your dashboards. This Skill guides you through creating the rill.yaml file.

Quick Start

Use the rill-rillyaml skill to generate a basic rill.yaml file with a display name and description.

Frequently Asked Questions about rill-rillyaml

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I configure the rill.yaml file for a new Rill project?

Configuring the rill.yaml file involves defining project metadata, setting the default OLAP connector like DuckDB or ClickHouse, and managing environment variables. You can also establish project-wide defaults for models and dashboards within this central configuration file.

What is the purpose of mock users in rill.yaml configuration?

Mock users in rill.yaml are used for testing security policies during development. By defining mock users, you can simulate different user roles and permissions to verify that your data access controls and security configurations behave as expected before deployment.

How do I set the default OLAP database connection in Rill?

To set the default OLAP database connection in Rill, you specify the connector in the rill.yaml file. This configuration allows you to choose between supported databases like DuckDB or ClickHouse to handle your project's analytical queries.

Can I control which files are parsed or exposed in a Rill project?

Yes, you can control file parsing and exposure in Rill using the ignore_paths and public_paths settings within rill.yaml. These path management options allow you to exclude specific files from being parsed or restrict public access to certain project resources.

How do I define environment variables for data sources in Rill?

You define environment variables in the rill.yaml file to manage data source credentials and configuration. This approach enables environment-specific overrides, allowing you to securely pass different variables for development and production without altering the core project files.

How do I set default time ranges for dashboards in a Rill project?

To set default time ranges for dashboards, you configure resource defaults in the rill.yaml file. This project-wide setting allows you to define standard behaviors for metrics views and explores, ensuring consistent default visualizations across your Rill dashboards.