Utility Commands

Overview

Utility commands provide quick access to the Lua Admin interface, documentation, and shell autocomplete setup.

lua completion

Generate shell autocomplete

lua admin

Open admin dashboard

lua evals

Open evaluations dashboard

lua docs

Open documentation

New in v2.6.0: Shell autocomplete support for Bash, Zsh, and Fish!

lua completion

Generate shell autocomplete scripts for faster command-line workflows.

lua completion [shell]       # Generate completion script
lua completion bash          # Generate for Bash
lua completion zsh           # Generate for Zsh
lua completion fish          # Generate for Fish

New in v2.6.0: Enable tab completion for all Lua CLI commands and arguments!

What It Does

Generates shell-specific completion scripts that enable:

✅ Tab completion for all commands
✅ Subcommand suggestions
✅ Environment option suggestions (sandbox, staging, production)
✅ Argument completion for push, env, persona, skills
✅ Context-aware completions

Supported Shells

Bash
Zsh
Fish

Installation

# Add to your ~/.bashrc
lua completion bash >> ~/.bashrc
source ~/.bashrc

# Or for one-time setup
echo 'eval "$(lua completion bash)"' >> ~/.bashrc
source ~/.bashrc

Test it

lua pu<TAB>           # Completes to: lua push
lua push <TAB>        # Shows: skill, persona
lua env <TAB>         # Shows: sandbox, staging, production
lua persona <TAB>     # Shows: sandbox, staging, production

Installation

# Add to your ~/.zshrc
lua completion zsh >> ~/.zshrc
source ~/.zshrc

# Or for one-time setup
echo 'eval "$(lua completion zsh)"' >> ~/.zshrc
source ~/.zshrc

Test it

lua <TAB>             # Shows all commands
lua skills <TAB>      # Shows: sandbox, staging, production
lua auth <TAB>        # Shows: configure, logout, key

Installation

# Create completions directory if it doesn't exist
mkdir -p ~/.config/fish/completions

# Generate completion file
lua completion fish > ~/.config/fish/completions/lua.fish

# Completions are automatically loaded

Test it

lua <TAB>             # Shows all commands with descriptions
lua push <TAB>        # Shows: skill, persona
lua env <TAB>         # Shows: sandbox, staging, production

Completion Features

Main Commands

Tab completion for all Lua CLI commands:

lua a<TAB>        # auth, admin
lua p<TAB>        # push, persona, production
lua s<TAB>        # skills
lua e<TAB>        # env
lua f<TAB>        # features
lua c<TAB>        # compile, completion, chat, channels

Subcommands

Context-aware subcommand completion:

lua auth <TAB>         # configure, logout, key
lua push <TAB>         # skill, persona
lua chat <TAB>         # clear
lua completion <TAB>   # bash, zsh, fish

Environment Options

Environment selection for applicable commands:

lua env <TAB>          # sandbox, staging, production
lua persona <TAB>      # sandbox, staging, production
lua skills <TAB>       # sandbox, staging, production

Help Flags

Common flags available for all commands:

lua --<TAB>            # --help, --version
lua push --<TAB>       # --help

Verification

After installation, verify autocomplete is working:

Test Basic Completion
Test Subcommands
Test Environment

# Type this and press TAB
lua pu

# Should complete to:
lua push

# Type this and press TAB
lua push 

# Should show options:
skill  persona

# Type this and press TAB
lua env 

# Should show:
sandbox  staging  production

Troubleshooting

Completions not working

Problem: Tab completion doesn’t work after installationSolutions:

Restart your terminal or reload shell config:

# Bash
source ~/.bashrc

# Zsh
source ~/.zshrc

# Fish (automatic)

Verify script was added correctly:

# Check if completion is in config
tail ~/.bashrc    # or ~/.zshrc

Try explicit installation:

eval "$(lua completion bash)"  # Or zsh

Completions incomplete

Problem: Some commands complete, others don’tSolutions:

Regenerate completion script:

lua completion bash > /tmp/lua_completions
cat /tmp/lua_completions >> ~/.bashrc
source ~/.bashrc

Check Lua CLI version:

lua --version
# Should be v2.6.0 or higher

Fish completions not loading

Problem: Completions don’t work in Fish shellSolutions:

Verify file location:
```
ls ~/.config/fish/completions/lua.fish
```

Regenerate if missing:

mkdir -p ~/.config/fish/completions
lua completion fish > ~/.config/fish/completions/lua.fish

Restart Fish shell

Conflict with existing completions

Problem: Completions conflict with other toolsSolution: Remove old completion and reinstall:

# Bash/Zsh: Remove old lines from config file
vim ~/.bashrc  # or ~/.zshrc
# Delete old lua completion lines

# Fish: Remove old file
rm ~/.config/fish/completions/lua.fish

# Reinstall
lua completion [your-shell]

Benefits

Faster Workflow

Type less, complete more with tab

Discover Commands

See available options without docs

Fewer Typos

Autocomplete prevents mistakes

Better UX

Professional CLI experience

Advanced Usage

Multiple Shells

If you use multiple shells, install for each:

# Bash
lua completion bash >> ~/.bashrc

# Zsh
lua completion zsh >> ~/.zshrc

# Fish
lua completion fish > ~/.config/fish/completions/lua.fish

Team Setup

Add to team onboarding:

# In your team's setup script
echo "Setting up Lua CLI autocomplete..."
lua completion bash >> ~/.bashrc
source ~/.bashrc
echo "✅ Autocomplete enabled"

Docker/Remote

Include in Docker images:

# In Dockerfile
RUN lua completion bash >> /root/.bashrc

lua admin

Launch the Lua Admin interface in your default browser.

lua admin

What It Opens

The Lua Admin Dashboard provides complete control over your agent: Conversations

💬 View conversations in real-time
📝 Reply to user messages
📊 Monitor conversation quality
🔍 Search conversation history
📈 Analyze user interactions

User Management

👥 Add users to your agent
✏️ Edit user permissions
🗑️ Remove users
👀 View user activity
📊 User analytics

API Keys

🔑 Generate new API keys
👁️ View existing keys
🗑️ Revoke keys
📋 Copy keys for development
🔒 Manage key permissions

Channel Connections

📱 WhatsApp integration
📸 Instagram messaging
✉️ Email integration
👍 Facebook Messenger
💬 Slack integration
📞 SMS/Twilio
🌐 Website chat widget
🔗 Custom integrations

Billing & Subscription

💳 View current plan
📊 Usage metrics
💰 Billing history
🔄 Update payment method
📈 Upgrade/downgrade plan

Example

$ lua admin
✓ Lua Admin Dashboard opened in your browser

  Dashboard URL: https://admin.heylua.ai
  Agent ID: agent-abc123
  Organization ID: org-xyz789

Requirements

Must be authenticated (lua auth configure)
Must be in a skill directory (has lua.skill.yaml)
Configuration must contain agent.agentId and agent.orgId

Use Cases

Monitor Conversations

$ lua admin

View live conversations
See how users interact with your agent
Identify areas for improvement
Take over conversations if needed

Manage Team Access

$ lua admin

Add team members
Set permissions (admin, developer, viewer)
Manage API keys per user
Control who can deploy

Connect Channels

$ lua admin

Connect WhatsApp Business
Set up Instagram messaging
Configure email integration
Add Slack workspace
Enable Facebook Messenger

Review Analytics

$ lua admin

View conversation metrics
Check response times
Monitor user satisfaction
Track tool usage
Analyze peak times

Manage Billing

$ lua admin

Review usage this month
Check billing history
Update payment method
Upgrade subscription
Download invoices

Troubleshooting

Dashboard doesn't open

Check:

Run lua auth configure to authenticate
Ensure lua.skill.yaml exists (lua init)
Verify agent ID is in config

Error: “No API key found”

$ lua auth configure

Wrong agent displayed

Check:

Verify you’re in correct project directory
Check agentId in lua.skill.yaml
Switch to correct agent directory

Permission denied

Check:

Verify you have admin access
Check with organization owner
Request proper permissions

lua evals

Launch the Lua Evaluations Dashboard in your default browser.

lua evals

What It Opens

The Lua Evaluations Dashboard at https://evals.heylua.ai provides tools to test and evaluate your agent: Evaluation Features

🧪 Test your agent with predefined scenarios
📊 View evaluation results and metrics
📈 Track agent performance over time
🔍 Identify areas for improvement
✅ Validate agent responses

Example

$ lua evals
✓ Lua Evaluations Dashboard opened in your browser

  Dashboard URL: https://evals.heylua.ai
  Agent ID: agent-abc123

Requirements

Must be authenticated (lua auth configure)
Must be in a skill directory (has lua.skill.yaml)
Configuration must contain agent.agentId

Use Cases

Test Agent Responses

$ lua evals

Run predefined test scenarios
Validate agent behavior
Check response quality
Ensure consistency

Track Performance

$ lua evals

Monitor evaluation scores
Compare across versions
Identify regressions
Measure improvements

Quality Assurance

$ lua evals

Run evaluations before deployment
Validate production readiness
Document test results
Share with team

Troubleshooting

Dashboard doesn't open

Check:

Run lua auth configure to authenticate
Ensure lua.skill.yaml exists (lua init)
Verify agent ID is in config

Error: “No API key found”

$ lua auth configure

Wrong agent displayed

Check:

Verify you’re in correct project directory
Check agentId in lua.skill.yaml
Switch to correct agent directory

lua docs

Launch this documentation in your default browser.

lua docs

What It Opens

Opens the complete Lua documentation at https://docs.heylua.ai Sections:

🏠 Overview and getting started
📖 Key concepts (Persona, Skills, Tools, Resources)
⌨️ All CLI commands
📚 Complete API reference
💼 11 production-ready demos
💬 LuaPop chat widget guide

Example

$ lua docs
✓ Lua Documentation opened in your browser

  Documentation: https://docs.heylua.ai

Requirements

None - works from anywhere

Use Cases

Quick Reference

# Forgot a command syntax?
$ lua docs
# Navigate to CLI Commands

API Lookup

# Need API method signature?
$ lua docs
# Go to API Reference

Find Examples

# Need an example for your use case?
$ lua docs
# Check Demos section

Share with Team

Keyboard Shortcut

Add to your shell profile for even faster access:

# Add to ~/.zshrc or ~/.bashrc
alias ld='lua docs'

# Usage
$ ld
# Opens documentation instantly

Quick Comparison

Command	Opens/Generates	Requires Auth	Use For
`lua completion`	Shell completion script	❌ No	Tab completion, faster workflows
`lua admin`	Admin dashboard	✅ Yes	Managing agent, conversations, billing
`lua evals`	Evaluations dashboard	✅ Yes	Testing agent, tracking performance
`lua docs`	Documentation	❌ No	Reference, examples, learning

Integration with Workflow

During Development

# Need API reference?
$ lua docs
# Check API section

# Continue coding

During Deployment

# Deploy skills
$ lua push
$ lua deploy

# Check admin dashboard
$ lua admin
# Monitor conversations
# Verify deployment working

When Troubleshooting

# Issue with command
$ lua docs
# Search troubleshooting section

# Check production state
$ lua admin
# View live conversations
# Check for errors

Next Steps

All CLI Commands

Complete command reference

Admin Features

Explore the admin dashboard

Getting Started

New to Lua? Start here

Demos

11 production-ready solutions

Getting Started

Core Concepts

CLI Commands

API Reference

Template & Examples

​Overview

lua completion

lua admin

lua evals

lua docs

​lua completion

​What It Does

​Supported Shells

​Completion Features

​Verification

​Troubleshooting

​Benefits

Faster Workflow

Discover Commands

Fewer Typos

Better UX

​Advanced Usage

​lua admin

​What It Opens

​Example

​Requirements

​Use Cases

​Troubleshooting

​lua evals

​What It Opens

​Example

​Requirements

​Use Cases

​Troubleshooting

​lua docs

​What It Opens

​Example

​Requirements

​Use Cases

​Keyboard Shortcut

​Quick Comparison

​Integration with Workflow

​During Development

​During Deployment

​When Troubleshooting

​Next Steps

All CLI Commands

Admin Features

Getting Started

Demos

Overview

lua completion

What It Does

Supported Shells

Completion Features

Verification

Troubleshooting

Benefits

Advanced Usage

lua admin

What It Opens

Example

Requirements

Use Cases

Troubleshooting

lua evals

What It Opens

Example

Requirements

Use Cases

Troubleshooting

lua docs

What It Opens

Example

Requirements

Use Cases

Keyboard Shortcut

Quick Comparison

Integration with Workflow

During Development

During Deployment

When Troubleshooting

Next Steps