Lua AI CLI v3.0.0
Build and deploy AI agents with superpowersNew in v3.1.0 (Marketplace): - 🛒 Lua Marketplace - Discover, install, and publish skills directly from the CLI with
lua marketplace.New in v3.0.0 (lua-cli package): - 🤖 LuaAgent - Unified agent
configuration with persona, skills, webhooks, jobs, and processors - 🪝
LuaWebhook - HTTP endpoints for external integrations (Stripe, Shopify,
etc.) - ⏰ LuaJob - Scheduled tasks with cron patterns - 📥
PreProcessor - Filter and route messages before they reach your agent - 📤
PostProcessor - Transform and format agent responses - 🔄 Jobs API -
Dynamically create scheduled tasks from tools
New in v2.6.0 (CLI commands): - 🎯 Direct environment access for all
commands - ⌨️ Shell autocomplete support (Bash, Zsh, Fish) - 🚀 New
lua skills command for production skill management - ⚡ New lua features
command for managing agent capabilities - ⚡ Faster workflows with lua push skill, lua env production, etc.Options
All Commands
| Command | Category | Description |
|---|---|---|
lua auth | 🔐 Authentication | Manage API keys and authentication |
lua init | 🚀 Project Setup | Initialize a new Lua skill project |
lua env | ⚙️ Configuration | Manage environment variables (sandbox/production) |
lua persona | 🤖 Configuration | Manage agent persona (sandbox/production) |
lua features | ⚡ Configuration | Manage agent capabilities and features |
lua resources | 📚 Configuration | Manage agent knowledge base |
lua marketplace | 🛒 Ecosystem | Discover, install, and publish skills |
lua skills | 🔧 Development | View and manage skills (sandbox/production) |
lua compile | 📦 Development | Compile skill to deployable format |
lua sync | 🔄 Development | Detect and resolve drift between server and local code |
lua test | 💬 Testing | Test skill tools interactively |
lua chat | 💬 Testing | Interactive chat with your agent |
lua push | ☁️ Deployment | Push components to server |
lua deploy | 🚀 Deployment | Deploy version to production |
lua mcp | 🔌 Integration | Manage MCP (Model Context Protocol) servers |
lua production | 🚀 Deployment | View and manage production environment |
lua channels | 🔌 Integration | Manage communication channels |
lua logs | 🐛 Debugging | View and filter agent logs by component type (Skills, Jobs, Webhooks, etc.) |
lua completion | ⌨️ Utilities | Generate shell autocomplete scripts |
lua admin | 🛠️ Utilities | Open admin dashboard in browser |
lua evals | 📊 Utilities | Open evaluations dashboard in browser |
lua docs | 📖 Utilities | Open documentation in browser |
Quick Examples
Get help for any command:
Support: https://heylua.ai/support
lua [command] --help or lua help [command]Documentation: https://docs.heylua.aiSupport: https://heylua.ai/support
Quick Command Reference
lua init
Initialize new skill project
lua skills
View and manage skills
lua env
Manage environment variables
lua persona
Configure agent personality
lua features
Manage agent capabilities
lua mcp
Manage MCP servers
lua sync
Detect and resolve drift
lua test
Test tools interactively
lua chat
Interactive chat with your agent
lua push
Upload version to server
lua deploy
Deploy to production
lua completion
Shell autocomplete setup
Shell Autocomplete ⚡ NEW
Enable tab completion for all Lua CLI commands and arguments:- Bash
- Zsh
- Fish
Learn More
Direct Mode ⚡ NEW
Skip interactive prompts by specifying your target directly:- Push Commands
- Environment Commands
- Persona Commands
- Skills Commands
Command Categories
Authentication
- configure
- key
- logout
Set up API key authenticationChoose between:
- Email: OTP verification
- API Key: Existing key
Learn More
Skill Management
- init
- compile
- test
- push
- deploy
- chat
Create new skill projectDefault (minimal):
- Clean agent ready to customize
- TypeScript configuration
lua.skill.yamlconfig
- 30+ example tools
- Example webhooks, jobs, processors
- Complete e-commerce flow examples
Learn More
Common Workflows
New Project Workflow
1
Authenticate
2
Initialize
3
Configure Environment
4
Configure Persona
5
Test Your Agent
Optional: Use
lua test to test individual tools with specific inputs6
Deploy
Development Workflow
1
Configure Environment (if needed)
2
Update Persona (if needed)
3
Make Changes
Edit your tools in
src/tools/*.ts4
Test Your Agent
Pro tip: Use
lua test to debug specific tool logic if needed5
Push Persona to Production (if changed)
lua push persona6
Push Skill When Ready
7
Deploy to Production
Quick Fix Workflow
Global Flags
All commands support:Environment Variables
Commands automatically load environment variables from:1
System Environment
Variables from your shell
2
.env File
Variables from project
.env3
lua.skill.yaml
Variables from skill config
Learn More
Error Handling
All commands include:- ✅ Descriptive error messages
- ✅ Exit codes (0 = success, 1 = error)
- ✅ Troubleshooting hints
Common Errors
No API key found
No API key found
lua auth configureNo lua.skill.yaml found
No lua.skill.yaml found
lua init firstVersion already exists
Version already exists
lua.skill.yaml (this is the only field you should manually edit)Compilation failed
Compilation failed
index.ts or src/index.ts with skill definitionMore Troubleshooting
v3.0.0 Agent Structure
Project Code Pattern
The v3.0.0 pattern usesLuaAgent for unified configuration:
Project Structure
Configuration File
lua.skill.yaml
Auto-managed state manifest (IDs and versions only):skillId- Created during compilationwebhookId- Created during compilationjobId- Created during compilationmcpServerId- Created during compilationskills,webhooks,jobs,mcpServersarrays - Populated from code- Versions/IDs are tracked here; persona/env/schedule live in code (sandbox) or server (production)
agentId- Set duringlua initorgId- Set duringlua initversion- Update when releasing (for each component)
System Requirements
Node.js
Version 16.0.0 or higher
npm
Version 7.0.0 or higher
TypeScript
Included in template (knowledge helpful)
Git
Optional but recommended
Storage Locations
- Credentials
- Project Files
- Temporary
System Keychain
- macOS: Keychain
- Windows: Credential Vault
- Linux: libsecret
Next Steps
Authentication
Set up API key authentication
Skill Management
Learn all skill management commands
Sync Command
Detect and resolve drift
Environment Command
Manage sandbox and production variables
Persona Command
Configure agent personality
Features Command
Manage agent capabilities
MCP Command
Manage MCP servers for external tools
Chat Command
Interactive chat with your agent
Utility Commands
Shell autocomplete and more

