Skip to content

Quick Start

Levi Smith edited this page Jul 29, 2024 · 3 revisions

This guide will help you get started with Rinse, Wash, Repeat (RWR) quickly. You’ll learn how to install RWR, set up a basic configuration, and run your first blueprint.

Prerequisites

Before you begin, ensure that you have the following:

  • A supported operating system (Linux, macOS, or Windows)

  • A compatible package manager (e.g., apt, brew, chocolatey)

  • Git installed on your system

Installation

To install RWR, follow these steps:

  1. Download the latest release of RWR from the releases page.

  2. Extract the downloaded archive to a directory of your choice.

  3. Add the directory to your system’s PATH environment variable.

Configuration

To set up a basic configuration for RWR, follow these steps:

  1. Create a new directory for your RWR configuration:

    mkdir my-rwr-config
    cd my-rwr-config
  2. Create an init.yaml file with the following content:

    blueprints:
      format: yaml
      location: blueprints
  3. Create a blueprints directory:

    mkdir blueprints
  4. Inside the blueprints directory, create a packages.yaml file with the following content:

    packages:
      - name: git
        action: install
      - name: curl
        action: install

Running Your First Blueprint

To run your first blueprint, follow these steps:

  1. Open a terminal and navigate to your RWR configuration directory:

    cd my-rwr-config
  2. Run the rwr all command to execute all blueprints:

    rwr all

RWR will now process the packages.yaml blueprint and install the specified packages (git and curl) using the default package manager for your system.

Next Steps

Congratulations! You have successfully installed RWR, set up a basic configuration, and run your first blueprint.

Next, you can:

  • Explore the Blueprints Overview to learn more about the different blueprint types and their capabilities.

  • Customize your configuration by adding more blueprints and adjusting the init.yaml file.

  • Learn how to use Variables to make your blueprints more dynamic and reusable.

  • Discover Best Practices for organizing and managing your RWR configurations.

If you encounter any issues or have questions, please refer to the Troubleshooting section or reach out to the RWR community for support.