Commands

Generators

railsui:scaffold

Generate a fully themed scaffold for a new resource. This works like the standard Rails scaffold generator but uses your active theme's styled templates.

rails generate railsui:scaffold Post title:string body:text published:boolean

This generates:

• Model, migration, and controller (same as Rails default)
• Pre-styled views matching your theme: index, show, new, edit, and form partial
• Routes added to config/routes.rb

Rake tasks

railsui:install

Run this task to install Rails UI. The default theme, Hound, is installed and can be changed anytime.

rails railsui:install

railsui:update

Updates your Rails UI configuration. Use this to manually save your railsui.config file after manual tweaks.

rails railsui:update

railsui:pages

Returns the list of installed pages for your active theme.

Pages are read-only. Removed pages return when updating configuration. To customize, copy pages to another view directory.

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

Pass a theme name directly. 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