instance method `rails_command`

Ruby on Rails 8.1.2

Since v5.2.8.1

Available in: v5.2.8.1 v6.0.6 v6.1.7.10 v7.0.10 v7.1.6 v7.2.3 v8.0.4 v8.1.2

Compare with:

rails_command(command, options = {})

Runs the specified Rails command.

rails_command "db:migrate"
rails_command "db:migrate", env: "production"
rails_command "db:migrate", abort_on_failure: true
rails_command "stats", capture: true
rails_command "gems:install", sudo: true

Options

:env: The Rails environment in which to run the command. Defaults to ENV["RAILS_ENV"] || "development".
:abort_on_failure: Whether to halt the generator if the command exits with a non-success exit status.
:capture: Whether to capture and return the output of the command.
:sudo: Whether to run the command using sudo.

Parameters

command req
options opt = {}

Source

# File railties/lib/rails/generators/actions.rb, line 391
      def rails_command(command, options = {})
        if options[:inline]
          log :rails, command
          command, *args = Shellwords.split(command)
          in_root do
            silence_warnings do
              ::Rails::Command.invoke(command, args, **options)
            end
          end
        else
          execute_command :rails, command, options
        end
      end

Defined in railties/lib/rails/generators/actions.rb line 391 · View on GitHub · Improve this page · Find usages on GitHub

Defined in Rails::Generators::Actions

Signature

Options

Parameters