Rails how to run rake task

Question

How do I run this rake file in terminal/console?

my statistik.rake in lib/tasks

desc "Importer statistikker"
namespace :reklamer do
  task :iqmedier => :environment do
    ...
  end
  task :euroads => :environment do
    ...
  end
  task :mikkelsen => :environment do
    ...
  end
  task :orville => :environment do
    ...
  end
end

Andrew Marshall · Accepted Answer · 2019-11-02T23:08:40.243

157

You can run Rake tasks from your shell by running:

rake task_name

To run from from Ruby (e.g., in the Rails console or another Rake task):

Rake::Task['task_name'].invoke

To run multiple tasks in the same namespace with a single task, create the following new task in your namespace:

task :runall => [:iqmedier, :euroads, :mikkelsen, :orville] do
  # This will run after all those tasks have run
end

edited Nov 02 '19 at 23:08

answered Apr 12 '11 at 21:24

Andrew Marshall

95,083
20
220
214

1

How do I rake all the tasks at once or do I need to change the namespace to a task? – Rails beginner Apr 12 '11 at 21:33
1

If you want to run all the tasks at once make task :all => [:a, :b, :c] and then run rake reklamer:all – Spike Gronim Apr 12 '11 at 21:37
1

That wasn't part of your question, but you'd have to make a new task that calls each of them, which there is a shorthand for. See my updated answer. – Andrew Marshall Apr 12 '11 at 21:38
1

@Andrew Marshall, btw, you can use `task :runall => Rake::Task.tasks` if you want to run all the tasks. But this line must be declared after all tasks. – Vasiliy Ermolovich Apr 12 '11 at 21:43
Where should the task :runall => go? – Rails beginner Apr 12 '11 at 23:14
@tzown, as I said in my answer, it should go in the same namespace as the other tasks you want it to run. – Andrew Marshall Apr 12 '11 at 23:45
@AndrewMarshall One potential pitfall of running multiple tasks like your ```:runall``` example above is that it will fail if any of the individual tasks fail – thoughtpunch Jan 24 '13 at 21:38
@thoughtpunch Right, because they’re dependencies of the task. – Andrew Marshall Jan 24 '13 at 23:31
what are the pitfalls of running the task from ruby? – kisai Jun 23 '19 at 05:40
If you're passing parameters from the command line on Mac/Linux, ensure that you escape the square brackets like so: rake my_task\\[1234\\] – oddmeter Jun 29 '21 at 23:23
@oddmeter Whether `[` and `]` need some form of escaping depends on your shell. Generally, though, I would suggest surrounding in single-quotes rather than awkward backslash-escaping. – Andrew Marshall Jun 30 '21 at 12:45

score 30 · Answer 2 · answered Apr 12 '11 at 21:25

30

Rake::Task['reklamer:orville'].invoke

or

Rake::Task['reklamer:orville'].invoke(args)

answered Apr 12 '11 at 21:25

Luke W

8,276
5
44
36

This approach will work, but the "correct" way to bundle up raks tasks was answered by @andrew-marshall. – Tom Harrison Oct 15 '12 at 14:17
4

please provide reference if you're going to say something like 'the "correct" way...'. my answer was a response to the original question. – Luke W Oct 24 '12 at 19:32
3

As a theoretical test, I tried running `Rake::Task['db:seed'].invoke` but it does not run, saying "Don't know how to build task 'db:seed'" – lulalala Sep 04 '13 at 07:40
See this [answer](https://stackoverflow.com/a/49400110/7037546) if you get the error "_Don't know how to build task_" – dlauzon Mar 10 '22 at 21:21

score 28 · Answer 3 · edited Nov 18 '18 at 05:12

28

Sometimes Your rake tasks doesn't get loaded in console, In that case you can try the following commands

require "rake"
YourApp::Application.load_tasks
Rake::Task["Namespace:task"].invoke

edited Nov 18 '18 at 05:12

Joshua Pinter

45,245
23
243
245

answered Mar 21 '18 at 07:01

Bloomberg

2,317
2
25
47

Those quotes are bad but I can't edit them because it is too small an edit! – nroose May 20 '18 at 00:53
2

Even though this is not a real answer to the question asked. This is what I have been looking for and solved my problem (YourApp::Application.load_tasks). Thanks! – Dennis van de Hoef - Xiotin Mar 13 '20 at 09:51
2

`Rails.application.load_tasks` (instead of `YourApp::Application.load_tasks`) can also be used, to be slightly more generic. – dlauzon Mar 10 '22 at 21:18

score 24 · Answer 4 · answered Apr 12 '11 at 21:20

24

Have you tried rake reklamer:iqmedier ?

My custom rake tasks are in the lib directory, not in lib/tasks. Not sure if that matters.

answered Apr 12 '11 at 21:20

CharlieMezak

5,999
1
38
54

1

I want to run all tasks at once – Rails beginner Apr 12 '11 at 21:22

score 15 · Answer 5 · answered Feb 14 '19 at 19:13

If you aren't sure how to run a rake task, first find out first what tasks you have and it will also list the commands to run the tasks.

Run rake --tasks on the terminal.

It will list the tasks like the following:

rake gobble:dev:prime             
rake gobble:dev:reset_number_of_kits                                    
rake gobble:dev:scrub_prod_data

You can then run your task with: rake gobble:dev:prime as listed.

score 3 · Answer 6 · answered Apr 13 '21 at 05:37

As the https://stackoverflow.com/a/5641807/7262646 and https://stackoverflow.com/a/49400110/7262646 described

you have to add

require 'rake'
Rake::Task.clear
YourAppName::Application.load_tasks

on the top of the file.

YourAppName comes from config/applicaion.rb, which is defined as a namespace, such as:

module YourAppName
  class Application < Rails::Application
  end
end

and then you can use

Rake::Task["task_name"].invoke

to invoke your task.

score 1 · Answer 7 · answered Sep 28 '15 at 17:15

In rails 4.2 the above methods didn't work.

Go to the Terminal.
Change the directory to the location where your rake file is present.
run rake task_name.
In the above case, run rake iqmedier - will run only iqmedir task.
run rake euroads - will run only the euroads task.

To Run all the tasks in that file assign the following inside the same file and run rake all

task :all => [:iqmedier, :euroads, :mikkelsen, :orville ] do #This will print all the tasks o/p on the screen 
end

Rails how to run rake task

7 Answers7

Linked