Railsnew

App Name Set the name of the application The `--name=NAME` flag allows you to define the name of the application. If not specified, a default name will be used.

Presets

Choose a preset configuration for your Rails app.

No preset

No specific configuration will be applied.

If this option is selected, the app will be generated with the options specified.

API Only

Preconfigure the app for API-only usage.

If selected, the app will be configured with an API-only stack, omitting default frontend features.
\nBased on the specified options, the following options will also be activated:
\n  --skip-javascript [due to --api]
\n  --skip-hotwire [due to --skip-javascript]
\n  --skip-asset-pipeline [due to --api]

Minimal

Generate a minimal Rails application.

If selected, a minimal version of Rails will be generated with only the most essential components.
\nBased on the specified options, the following options will also be activated:

\n--skip-active-job [due to --minimal]
\n--skip-action-mailer [due to --skip-active-job, --minimal]
\n--skip-action-mailbox [due to --skip-active-storage, --minimal]
\n--skip-active-storage [due to --skip-active-job, --minimal]
\n--skip-action-text [due to --skip-active-storage, --minimal]
\n--skip-javascript [due to --minimal]
\n--skip-hotwire [due to --skip-javascript, --minimal]
\n--skip-action-cable [due to --minimal]
\n--skip-bootsnap [due to --minimal]
\n--skip-dev-gems [due to --minimal]
\n--skip-jbuilder [due to --minimal]
\n--skip-system-test [due to --minimal]

Database Options

Select a database configuration for your app.

SQLite3

Use SQLite3 as the database for the application.

If selected, SQLite3 will be configured as the default database.

MySQL

Use MySQL as the database for the application.

If selected, MySQL will be configured as the default database.

Trilogy

Use Trilogy as the database (alternative to MySQL).

If selected, Trilogy will be configured as the default database.

MariaDB (MySQL)

Use MariaDB (compatible with MySQL) as the database.

If selected, MariaDB will be configured as the database using MySQL.

MariaDB (Trilogy)

Use MariaDB with Trilogy as the database.

If selected, MariaDB will be configured as the database using Trilogy.

PostgreSQL

Use PostgreSQL as the database for the application.

If selected, PostgreSQL will be configured as the default database.

Asset Pipeline

Configure the asset pipeline for your app.

None

Do not include an asset pipeline.

If selected, no asset pipeline will be configured for managing assets.

Propshaft

Use Propshaft as the asset pipeline.

If selected, Propshaft will be configured as the asset pipeline.

Sprockets

Use Sprockets as the asset pipeline.

If selected, Sprockets will be configured as the asset pipeline.

CSS Framework

Choose a CSS framework for your application.

* Check https://github.com/rails/cssbundling-rails for more information.

No CSS Framework

Do not include any CSS framework.

If selected, no CSS framework will be configured.

Tailwind CSS

Use Tailwind CSS as the CSS framework.

If selected, Tailwind CSS will be configured for the application.

Bootstrap

Use Bootstrap as the CSS framework.

If selected, Bootstrap will be configured for the application.

Bulma

Use Bulma as the CSS framework.

If selected, Bulma will be configured for the application.

PostCSS

Use PostCSS as the CSS framework.

If selected, PostCSS will be configured for the application.

Sass

Use Sass as the CSS framework.

If selected, Sass will be configured for the application.

JavaScript

Choose a JavaScript bundling tool for your app.

Javascript

Do not include any JavaScript bundler or framework.

If selected, no JavaScript setup will be configured.

Importmap

Use Importmap for managing JavaScript dependencies.

If selected, Importmap will be used as the default JavaScript bundler.

ESBuild

Use ESBuild as the JavaScript bundler.

If selected, ESBuild will be configured for bundling JavaScript.

Rollup

Use Rollup as the JavaScript bundler.

If selected, Rollup will be configured for bundling JavaScript.

Webpack

Use Webpack as the JavaScript bundler.

If selected, Webpack will be configured for bundling JavaScript.

Bun

Use Bun as the JavaScript bundler.

If selected, Bun will be configured for bundling JavaScript.

Rails Components

Enable or disable specific Rails components.

Action Mailer

Include Action Mailer functionality

**With `--skip-action-mailer`:**
  - Action Mailer configuration and files are not generated.
  - Email-sending functionality will not be available, which could be problematic if notifications or communications need to be sent.

**Without `--skip-action-mailer`:**
  - All necessary configurations and files for Action Mailer are included.
  - The app will be ready to send emails.

Action Mailbox

Include Action Mailbox for handling incoming emails

**With `--skip-action-mailbox`:**
  - The Action Mailbox gem is not included.
  - The app will not be able to handle incoming emails, limiting its ability to process email-based workflows.

**Without `--skip-action-mailbox`:**
  - The Action Mailbox gem is included.
  - The app will be equipped to handle incoming emails and create workflows based on them.

Action Text

Include Action Text for rich content

**With `--skip-action-text`:**
  - The Action Text gem is not included.
  - The app will not support rich text editing.

**Without `--skip-action-text`:**
  - The Action Text gem is included.
  - The app will be able to handle rich text content, facilitating the creation of interactive content.

Active Record

Include Active Record for database interaction

**With `--skip-active-record`:**
  - Active Record files are not generated.
  - The app will not be able to interact with relational databases, limiting its ability to store and retrieve data.

**Without `--skip-active-record`:**
  - All necessary files for Active Record are generated.
  - The app will be configured to interact with relational databases.

Active Job

Include Active Job for background job processing

**With `--skip-active-job`:**
  - Active Job files and configurations are not generated.
  - Background job processing will not be available, affecting tasks that should be executed asynchronously.

**Without `--skip-active-job`:**
  - Active Job files and configurations are included.
  - The app will be ready to handle background jobs.

Active Storage

Include Active Storage for file uploads

**With `--skip-active-storage`:**
  - Active Storage files and configurations are not generated.
  - The app will not be able to manage file uploads, limiting its ability to handle user files.

**Without `--skip-active-storage`:**
  - Active Storage files and configurations are generated.
  - The app will be able to efficiently handle file uploads and storage.

Action Cable

Include Action Cable for real-time WebSocket features

**With `--skip-action-cable`:**
  - Action Cable files are not included.
  - Real-time communication via WebSockets will not be available.

**Without `--skip-action-cable`:**
  - Action Cable files and configurations are generated.
  - The app will support real-time communication through WebSockets.

Jbuilder

Include Jbuilder for building JSON APIs

**With `--skip-jbuilder`:**
  - The Jbuilder gem is not included.
  - Building JSON APIs may be more difficult without the Jbuilder gem.

**Without `--skip-jbuilder`:**
  - The Jbuilder gem is included.
  - The app will be able to build JSON APIs more easily.

Hotwire

Include Hotwire integration for reactive updates

**With `--skip-hotwire`:**
  - Hotwire integration is omitted.
  - Real-time reactive updates will not be available, limiting the user experience.

**Without `--skip-hotwire`:**
  - Hotwire is included.
  - The app will be able to provide real-time reactive updates, improving the user experience.

Housekeeping

Manage system maintenance options for your app.

Git

Initialize a Git repository

**With `--skip-git`:**
  - Git repository initialization is skipped.
  - `.gitignore` and `.gitattributes` files are not generated, which may lead to inefficient file tracking and the inclusion of unwanted files in version control.

**Without `--skip-git`:**
  - A Git repository is initialized.
  - `.gitignore` and `.gitattributes` files are automatically created to optimize version control and prevent unnecessary files from being tracked.

.keep Files

Include .keep files for source control

**With `--skip-keeps`:**
  - `.keep` files are not generated in empty directories.
  - Empty folders may not be preserved in version control, potentially leading to the loss of important directory structures.

**Without `--skip-keeps`:**
  - `.keep` files are generated in empty directories.
  - Empty folders are preserved in version control, helping to maintain the project’s structure.

Bootsnap

Include Bootsnap for speeding up boot time

**With `--skip-bootsnap`:**
  - The Bootsnap gem is not included.
  - The app may have slower boot times, as file loading will not be optimized.

**Without `--skip-bootsnap`:**
  - The Bootsnap gem is included.
  - The app will have faster boot times due to optimized file loading.

Development Gems

Include additional development gems

**With `--skip-dev-gems`:**
  - Development gems like `web-console` are not included.
  - The app may lack useful debugging tools during development.

**Without `--skip-dev-gems`:**
  - Development gems are included.
  - The app will have additional tools to facilitate development and debugging.

RuboCop

Include RuboCop for code quality

**With `--skip-rubocop`:**
  - RuboCop configuration is not included.
  - The app may lack a tool to maintain code quality and consistency.

**Without `--skip-rubocop`:**
  - RuboCop is included.
  - The app will have tools to maintain code quality.

Brakeman

Include Brakeman for security scanning

**With `--skip-brakeman`:**
  - Brakeman is not included.
  - The app will not have a tool to scan for security vulnerabilities.

**Without `--skip-brakeman`:**
  - Brakeman is included.
  - The app will be equipped to perform security scans.

Continuous Integration

Include CI configuration files

**With `--skip-ci`:**
  - CI configuration files (e.g., GitHub Actions) are not generated.
  - Automating tests and deployments may be harder to implement.

**Without `--skip-ci`:**
  - CI configuration files are generated.
  - The app will be ready for automating tests and deployments.

Kamal

Include Kamal for easy deployment

**With `--skip-kamal`:**
  - Kamal configuration is not included.
  - Deploying the app may be less efficient.

**Without `--skip-kamal`:**
  - Kamal is included.
  - The app will be configured for easier deployment.

Solid

Include Solid for caching and queueing

**With `--skip-solid`:**
  - Solid is not included.
  - Caching and queuing features will not be available.

**Without `--skip-solid`:**
  - Solid is included.
  - The app will handle caching and queuing.

Docker

Include Docker configuration files

**With `--skip-docker`:**
  - The `Dockerfile`, `.dockerignore`, and `bin/docker-entrypoint` files are not generated.
  - The app is not configured to run in a Docker container, which could limit its portability and scalability in production environments.

**Without `--skip-docker`:**
  - The `Dockerfile`, `.dockerignore`, and `bin/docker-entrypoint` files are automatically generated.
  - The app is set up to run in a Docker container, facilitating management and deployment in various environments.

Devcontainer

Generate devcontainer files for development environments

**With `--skip-devcontainer`:**
  - Devcontainer configuration files are not generated.
  - Creating a consistent and replicable development environment may be more difficult.

**With `--devcontainer`:**
  - Devcontainer configuration files are generated.
  - Ideal for those who want a well-defined, easily replicable development environment.

**With `--no-devcontainer`:**
  - Devcontainer configuration files are generated, but additional environment settings are disabled.
  - Useful if you want to generate basic configuration files without additional setups.

**Without `--skip-devcontainer`:**
  - Devcontainer configuration files are generated.
  - This will help create an easy-to-configure development environment across different machines.

Testing

Configure testing options for your application.

Test Files

Include test files for the application

**With `--skip-test`:**
  - Test files are not generated.
  - The app will lack automated tests, which may hinder code quality and maintenance.

**Without `--skip-test`:**
  - Test files are included.
  - The app will be configured with automated tests, helping to ensure code quality.

System Test

Include system test files

**With `--skip-system-test`:**
  - System test files are not generated.
  - There will be no tests to verify the full behavior of the app in a simulated environment.

**Without `--skip-system-test`:**
  - System test files are generated.
  - The app will have tests that verify its behavior in a simulated environment, aiding in the validation of the user flow.

RailsNew

Let's create your Rails 8 new app!