LuCLI Documentation

Welcome to the LuCLI docs. This site is organized by what you want to do: get started quickly, run CFML from the CLI, manage Lucee servers, and configure projects safely.

Use the sidebar to browse, or start from one of the guided paths below.

New to LuCLI?

1. Understand what LuCLI is
   Read the high‑level overview:

   • Introduction

2. Install LuCLI and run your first server

   • Installation
   • First Run

3. Learn the basic command shape

   • CLI Basics
   • Help System

Running CFML from the command line

If you mainly want to run CFML scripts, components, or modules from the CLI:

• Shortcuts & Direct CFML Execution
• Running Scripts and Components
• LuCLI Command Scripts (.lucli/.luc)
• Interactive Terminal & REPL
• CFML Modules

Managing Lucee servers with lucee.json

For project/server configuration and environments:

• Server Configuration (lucee.json)
• Environment Variables in lucee.json
• Environments and Configuration Overrides

Day‑to‑day server commands:

• Starting Servers
• Stopping Servers & Checking Status
• Logs and Opening in the Browser
• Server Names & Multiple Servers

Preview and audit configuration:

• Configuration Dry‑Run Preview

Security, dependencies, and advanced config

Keep configuration repeatable and secrets out of source control:

• Secrets Management
• Server Locking
• (Overview) Secure configuration page to be added.

Manage libraries and extensions:

• Dependency Management
• Dependency Examples

AI Features

LuCLI has two major AI-related areas:

• AI prompting and configuration via lucli ai
• MCP tool serving via lucli mcp

Start here:

• AI Prompting, Rules, and Skills
• MCP Module Servers

Reference and contributing

If you already know what you’re looking for:

• Command Reference
• Contributing to Documentation
• Site Changelog

You can always return to this page from the "Docs" home link in the navigation, and use the left sidebar to jump directly to any topic.