Docs
Tasks

Rake tasks

railsui:install

Hopefully this one is obvious but to install Rails UI you run this task. The default theme, Hound, gets installed which you can change anytime.

rails railsui:install

railsui:update

Use this to update your current Rails UI configuration. This essentially is the manual way to save your railsui.config file if you happened to tweak it manually.

rails railsui:update

railsui:pages

Based on your active theme you can return the list of intstalled pages to reference.

Pages are read-only, so if you remove any and update your configuration after the first run, they'll be added back. To customize pages, copy them to another view directory in your app.

rails railsui:pages

# Example output:
# Page list for Hound theme:
# ---
#  - about
#  - pricing
#  - dashboard
#  - projects
#  - project
#  - messages
#  - message
#  - assignments
#  - calendar
#  - people
#  - profile
#  - activity
#  - settings
#  - notifications
#  - billing
#  - team
#  - integrations

You may also pass a theme name directly. Be sure to wrap the task in quotation marks.

rails "railsui:pages[shepherd]"

# Page list for Shepherd theme:
# ---
#  - about
#  - pricing
#  - dashboard
#  - projects
#  - project
#  - messages
#  - message
#  - assignments
#  - calendar
#  - people
#  - profile
#  - activity
#  - settings
#  - notifications
#  - billing
#  - team
#  - integrations