Skip to main content

​
Prerequisites

Node.js

Version 16.0.0 or higher

npm

Version 7.0.0 or higher

​
Installation Methods

Install Lua CLI globally to use it from anywhere: 
npm install -g lua-cli
Verify installation: 
lua --version

​
Using Package Runners (No Installation)

Run Lua CLI without installing: 
npx lua-cli [command]
Package runners are great for trying out Lua CLI, but global installation is recommended for regular use.

​
Authentication

After installation, set up your credentials: 
lua auth configure

​
Authentication Methods

​
Where Credentials are Stored

Credentials are stored securely in your system keychain:
  • macOS: Keychain
  • Windows: Credential Vault
  • Linux: libsecret
Never commit your API key to version control or share it publicly.

​
Verify Installation

Check that everything is working: 
# Check CLI version
lua --version

# View stored API key
lua auth key

# Get help
lua --help

​
Development Tools

While not required, these tools enhance the development experience:

VS Code

Recommended editor with TypeScript support

Git

Version control for your skills

​
TypeScript Setup

The template project includes TypeScript configuration. No additional setup needed! When you run lua init, you get:
  • tsconfig.json - TypeScript configuration
  • package.json - Dependencies
  • Full type definitions for all Lua APIs

​
Troubleshooting

Problem: The CLI isn’t in your PATHSolutions:
  • Reinstall globally: npm install -g lua-cli
  • Use npx instead: npx lua-cli [command]
  • Check npm global path: npm config get prefix
Problem: Need sudo for global installationSolution on Unix:
sudo npm install -g lua-cli
Better solution: Configure npm to install globally without sudo:
mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
export PATH=~/.npm-global/bin:$PATH
Problem: Authentication not configuredSolution:
lua auth configure
Problem: Node.js version is below 16.0.0Solution: Update Node.js

​
Next Steps

1

Create Your First Project

mkdir my-skill && cd my-skill
lua init
2

Explore the Template

Learn about the example tools and skills included

Template Guide

3

Start Building

Begin customizing tools for your use case

Building Skills