Skip to main content

​
🚀 Quick Start (5 Minutes)

Get from zero to your first deployed AI skill in minutes.
1

Install the CLI

npm install -g lua-cli
2

Set up authentication

lua auth configure
Choose Email and follow the prompts:
  1. Enter your email
  2. Check email for 6-digit code
  3. Enter the code
  4. Done! API key automatically generated and saved
3

Create your first skill

mkdir my-first-skill && cd my-first-skill
lua init
Choose “Create new agent” and follow prompts to set up your agentAfter init, the CLI typically surfaces a suggested loop: compile → test → sandbox chat → push & deploy — use it as your default checklist before customizing code.
4

Test it locally

lua test
Select a tool and try it out with different inputs!
5

Test and verify

# Production path: push, deploy (or push with --auto-deploy), then traffic, then logs
lua push && lua deploy
lua chat -m "your first test"

# Then check the logs (nothing appears until deployed AND you have generated traffic)
lua logs --type skill --limit 5
Every successful build has a verify step. The CLI suggests the next command after each action — follow the ✨ Tip: and 💡 Diagnose: hints printed at the end of lua push, lua chat, and lua test. After lua push without --auto-deploy, your code is staged but not live until you lua deploy. After every chat turn the CLI also runs a quiet agent_error probe and warns you if any pipeline errors fired during your test.For the full canonical loop, see Debugging your agent — the post-deploy loop.
Congratulations! You now have a working AI skill! 🎉

​
What You Just Created

When you ran lua init, you got:
  • ✅ Multiple skill examples
  • ✅ 30+ tool examples
  • ✅ Integration with all Lua platform APIs
  • ✅ TypeScript configuration
  • ✅ Ready to customize and deploy

​
Try These Commands

​
Test Individual Tools

lua test
Select tools to test:
  • get_weather - Enter city: “London”
  • search_products - Enter query: “laptop”
  • create_basket - Create a shopping cart

​
Test Your Tools

lua test
Try testing these tools:
  • get_weather - Enter “Tokyo”
  • search_products - Enter “laptop”
  • create_basket - Create a shopping cart
  • add_to_basket - Add items to cart

​
Test on Real Channels

Want to test your agent on WhatsApp, Facebook, Instagram, Email, or Slack without setting up your own channels?

Quick Testing Channels

Link your agent to existing Lua channels for instant testing on any platform

​
Next Steps

AI Agent Building Guide

Using Cursor, Windsurf, or Copilot? Complete guide for AI IDEs

Test on Real Channels

Test your agent on WhatsApp, Facebook, Instagram, and more

Understand the Template

Learn about the 30+ example tools included

Learn Core Concepts

Understand skills, tools, and how they work

Explore CLI Commands

Master all available CLI commands

API Reference

Dive into the complete API documentation

Set Up Your Own Channels

Connect your own channels for production

​
Common First Tasks

  1. Open src/tools/GetWeatherTool.ts
  2. Modify the execute function
  3. Save the file (auto-reloads in dev mode)
  4. Test in the chat interface
  1. Create src/tools/MyTool.ts
  2. Implement the LuaTool interface
  3. Add to skill in src/index.ts
  4. Run lua test to try it
lua push      # Upload version
lua deploy    # Deploy to production
  1. Delete tool files you don’t need from src/tools/
  2. Update src/index.ts to remove references
  3. Test with lua test

​
Need Help?

Discord Community

Chat with other builders, get help, and share your projects

Documentation

Complete guides and references

Email Support

Contact our support team