Text of rudderstack.com › docs › rudder-cli › project-setup as Styx crawled it on Nov 19, 2026. The page may have changed since. Only its words are kept, without pictures or layout.

Open the live page

Data Catalog Project Setup | RudderStack Docs

Select spec version: Data Catalog Project Setup Open in ChatGPT Open in Claude Open in Perplexity Set up your project containing the definitions of your Data Catalog resources. Available Plans free growth enterprise This guide shows you how to set up your project containing the definitions of your Data Catalog resources. Overview In the context of the Rudder CLI tool, a Data Catalog project typically consists of a root directory that contains all the project files.

Within this root directory, each YAML file can contain definitions for resources of a particular type, for example, events, properties, custom data types, and Tracking Plans. The location and naming of these YAML files is flexible, as you can store the YAML files anywhere within the project’s root directory or subdirectories. Set up your project The Rudder CLI tool expects the Data Catalog resources to be described in YAML files present in your system.

If you’re working with a Unix-compatible shell, run the following command to create a tutorial-catalog folder in your home directory, which you can use to populate the Data Catalog resources as YAML files: shell mkdir ~/tutorial-catalog The Rudder CLI tool automatically processes all valid YAML files within the project structure to recognize the defined resources. Next steps Create events Create event categories Create properties Create custom types See Data Catalog YAML Reference for the detailed YAML spec containing the definitions of these Data Catalog resources.

Questions? Let's figure it out together. Join the RudderStack Slack community to connect with other users, customers, and the RudderStack team — or reach out for direct support. Slack community Join now Email support Reach out This site uses cookies to improve your experience. If you want to learn more about cookies and why we use them, visit our cookie policy . We'll assume you're ok with this, but you can opt-out if you wish Privacy Overview This site uses cookies to improve your experience while you navigate through the website.

Out of these cookies, the cookies that are categorized as necessary are stored on your browser as they are as essential for the working of basic functionalities of the website. We also use third-party cookies that help us analyze and understand how you use this website. These cookies will be stored in your browser only with your consent. You also have the option to opt-out of these cookies. But opting out of some of these cookies may have an effect on your browsing experience.

Necessary cookies are absolutely essential for the website to function properly. This category only includes cookies that ensures basic functionalities and security features of the website. These cookies do not store any personal information.