Getting Started

Get up and running with DevRail in minutes. The devrail init script generates all DevRail configuration files in your project directory with a single command.

Quick Start

# Run devrail init in your project directory
curl -fsSL https://devrail.dev/init.sh | bash

This launches an interactive wizard that asks which languages you use, which CI platform you want (GitHub Actions or GitLab CI), and which DevRail layers to install. It generates all configuration files, handles existing file conflicts safely, and is idempotent (safe to re-run).

For non-interactive use:

# Generate everything for a Python project with GitHub Actions
curl -fsSL https://devrail.dev/init.sh | bash -s -- --all --languages python --ci github --yes

See the CLI Reference for all options.

Prerequisites

Before you begin, make sure you have the following installed on your machine:

All other tools (linters, formatters, security scanners, test runners) are pre-installed inside the dev-toolchain container. You do not need to install them on your host machine.

Choose Your Path

• New Project – Start a new repository with devrail init or from a template.
• Retrofit Existing Project – Add DevRail standards to a repository you already have.
• Working with AI Agents – Get AI coding agents to follow DevRail standards in your projects.
• CLI Reference – Full devrail init command reference.
• Compliance Badge – Add a DevRail compliance badge to your README.

Verify Your Setup

After setting up DevRail (any path), verify everything works by running:

# Run all DevRail checks (linting, formatting, security, tests)
make check

This command pulls the dev-toolchain Docker image (if not already cached), mounts your project directory, and runs every configured check inside the container. A passing make check means your project is DevRail-compliant.