Getting started
From gem install to live agent
Rails Agent is Heroku-simple for AI agents: add one gem, open /agents, chat with Kip, test, deploy. No AI expertise, no provider keys, no infra.
1 · Install the gem
Add rails-agent-stack to your Rails app (Ruby 3.2+, Rails 7+).
$ bundle add rails-agent-stack $ rails generate rails_agents:install
The generator mounts the engine at /agents, writes config/initializers/rails_agents.rb, and prints next steps. Defaults point at https://meerkatagents.com.
2 · Open /agents
Start your app and visit the mount point — same ergonomics as Sidekiq's /sidekiq.
$ bin/dev # open http://localhost:3000/agents
If you are not linked yet, the engine shows a short signup form. It handshakes with Rails Agent Cloud, saves your API key, then embeds the dashboard.
3 · Sign up in the mounted UI
Create a workspace with email + password (or use meerkatagents.com/signup). The handshake returns:
RAILS_AGENTS_API_KEY=ra_… RAILS_AGENTS_PROJECT_ID=ten_… RAILS_AGENTS_API_BASE=https://meerkatagents.com RAILS_AGENTS_DASHBOARD_BASE=https://meerkatagents.com
Or run rails-agents login from your app root for the same export lines.
4 · Vibe-code your first agent
In the dashboard, click Create your first agent, then describe it in chat — or pick a scaffold chip:
- Support triage bot
- Slack alert agent
- CRM lead qualifier
- Cron digest
Kip streams file writes into app/agents/<name>/ using RailsAgents::Base:
class Support < RailsAgents::Base
model :auto
memory :conversation
knowledge_from "knowledge/**/*"
tool :lookup_order do |order_id:|
Order.find(order_id).as_json
end
skill :triage, from: "skills/triage.rb"
channel :slack
end5 · Test → Deploy
Hit Test for a free sandbox run. When you are ready for production traffic, hit Deploy. Production requires the Studio plan (Stripe checkout) — development stays free.
$ rails-agents run support "Where is order 42?" $ rails-agents deploy support
Concept map · Eve → Rails folders
If you know Eve-style agent concepts, here is the Rails Agent mapping:
| Concept | In your Rails app | What it does |
|---|---|---|
| Instructions | prompt.md | System prompt in markdown — edit in chat or git. |
| Tools | tools/*.rb | Ruby methods the agent can call on your models. |
| Skills | skills/*.rb | Composable multi-step behaviors. |
| Channels | channels/*.rb | Slack, web chat, cron, API — where the agent lives. |
| Sandbox | Dashboard → Test | Safe runs against the cloud sandbox (free). |
| Subagents | app/agents/<other>/ | Other agent directories your agent can call. |
| Schedules | channels/cron.rb | Time-based triggers without a separate scheduler. |
| Evals | evals/*.yml | Golden conversations that run before deploy. |
Next
Learn the concepts
Deeper look at instructions, tools, skills, channels, sandbox, and evals in Rails terms.
Concepts →