Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions cli/src/commands/wheels/about.cfc
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,8 @@ component extends="base" {

// Helpful Links
print.boldGreenLine("Resources");
print.cyanLine(" Documentation: https://wheels.dev/docs");
print.cyanLine(" API Reference: https://wheels.dev/api");
print.cyanLine(" Documentation: https://wheels.dev/guides");
print.cyanLine(" API Reference: https://wheels.dev/api/v3.0.0");
print.cyanLine(" GitHub: https://github.com/wheels-dev/wheels");
print.cyanLine(" Community: https://wheels.dev/community");
print.line();
Expand Down
2 changes: 1 addition & 1 deletion cli/src/commands/wheels/dbmigrate/create/column.cfc
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
arguments = reconstructArgs(
argStruct = arguments,
allowedValues = {
dataType= ["string", "text", "integer", "biginteger", "float", "boolean", "date", "time", "datetime", "timestamp", "binary"]
dataType: ["biginteger", "binary", "boolean", "date", "datetime", "decimal", "float", "integer", "string", "text", "time", "timestamp", "uuid"]
}
);

Expand Down
12 changes: 6 additions & 6 deletions cli/src/commands/wheels/generate/app.cfc
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,11 @@ component aliases="wheels g app" extends="../base" {

// Map these shortcut names to the actual ForgeBox slugs
variables.templateMap = {
'Base' : 'wheels-base-template@BE',
'Base@BE' : 'wheels-base-template@BE',
'HelloWorld' : 'cfwheels-template-helloworld',
'HelloDynamic': 'cfwheels-template-hellodynamic',
'HelloPages' : 'cfwheels-template-hellopages'
'WheelsBaseTemplate' : 'wheels-base-template@^3.0.0',
'BleedingEdge' : 'wheels-base-template@BE',
'WheelsTemplateHTMX' : 'cfwheels-template-htmx-alpine-simple',
'WheelsStarterApp' : 'wheels-starter-app',
'WheelsTodoMVCHTMX' : 'cfwheels-todomvc-htmx'
};

return this;
Expand All @@ -68,7 +68,7 @@ component aliases="wheels g app" extends="../base" {
**/
function run(
name = 'MyApp',
template = 'wheels-base-template@BE',
template = 'wheels-base-template@^3.0.0',
directory,
reloadPassword = '',
datasourceName,
Expand Down
2 changes: 1 addition & 1 deletion cli/src/commands/wheels/generate/property.cfc
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ component aliases='wheels g property' extends="../base" {
arguments = reconstructArgs(
argStruct=arguments,
allowedValues={
dataType: ["biginteger", "binary", "boolean", "date", "datetime", "decimal", "float", "integer", "string", "limit", "text", "time", "timestamp", "uuid"]
dataType: ["biginteger", "binary", "boolean", "date", "datetime", "decimal", "float", "integer", "string", "text", "time", "timestamp", "uuid"]
}
);

Expand Down
2 changes: 1 addition & 1 deletion cli/src/commands/wheels/generate/scaffold.cfc
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ component aliases="wheels g scaffold, wheels g resource, wheels generate resourc

// Custom validation for properties parameter format (name:type,name2:type2)
if (len(trim(arguments.properties))) {
var validTypes = ["biginteger", "binary", "boolean", "date", "datetime", "decimal", "float", "integer", "string", "limit", "text", "time", "timestamp", "uuid"];
var validTypes = ["biginteger", "binary", "boolean", "date", "datetime", "decimal", "float", "integer", "string", "text", "time", "timestamp", "uuid"];
var properties = listToArray(arguments.properties, ",");
var invalidTypes = [];

Expand Down
1 change: 1 addition & 0 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
* Core Commands
* [wheels init](command-line-tools/commands/core/init.md)
* [wheels info](command-line-tools/commands/core/info.md)
* [wheels about](command-line-tools/commands/application-utilities/about.md)
* [wheels reload](command-line-tools/commands/core/reload.md)
* [wheels deps](command-line-tools/commands/core/deps.md)
* [wheels destroy](command-line-tools/commands/core/destroy.md)
Expand Down
29 changes: 14 additions & 15 deletions docs/src/command-line-tools/commands/application-utilities/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,41 +26,40 @@ wheels about

Output:
```
\ \ / / | | |
\ \ /\ / /| |__ ___ ___| |___
__ ___ _
\ \ / / | | |
\ \ /\ / /| |__ ___ ___| |___
\ \/ \/ / | '_ \ / _ \/ _ \ / __|
\ /\ / | | | | __/ __/ \__ \
\/ \/ |_| |_|\___|\___|_|___/
Wheels Framework
Version: 2.5.0
Version: 3.0.0
Wheels CLI
Version: 1.0.0
Version: 3.0.0
Location: /commandbox/modules/wheels-cli/
Application
Path: /Users/developer/myapp
Name: MyWheelsApp
Environment: development
Database: Configured
Server Environment
CFML Engine: Lucee 5.4.1.8
Java Version: 11.0.15
OS: macOS 13.0
CFML Engine: Lucee 7.0.1+100
Java Version: 17.0.17
OS: Mac OS X 15.7.3
Architecture: x86_64
CommandBox
Version: 5.9.0
Home: /Users/developer/.CommandBox
Version: 6.3.1+00853
Application Statistics
Controllers: 12
Models: 8
Views: 45
Tests: 23
Migrations: 15
Controllers: 15
Models: 7
Views: 31
Tests: 3
Migrations: 9
Resources
Documentation: https://wheels.dev/guides
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The `wheels generate app-wizard` command provides an interactive, step-by-step w
| `directory` | Directory to create app in | Valid directory path | `{current directory}/{name}` |
| `reloadPassword` | Reload password for the app | Any string | `changeMe` |
| `datasourceName` | Database datasource name | Valid datasource name | `{app name}` |
| `cfmlEngine` | CFML engine for server.json | `lucee`, `adobe`, `lucee6`, `lucee5`, `adobe2023`, etc. | `lucee` |
| `cfmlEngine` | CFML engine for server.json | `lucee5, lucee6, lucee7`, `adobe2018`, `adobe2021`, `adobe2023`, `adobe2025`, `boxlang`, etc. | `lucee` |
| `useBootstrap` | Add Bootstrap to the app | `true`, `false` | `false` |
| `setupH2` | Setup H2 database for development | `true`, `false` | `true` |
| `init` | Initialize directory as a package | `true`, `false` | `false` |
Expand Down
58 changes: 37 additions & 21 deletions docs/src/command-line-tools/commands/generate/app.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ wheels g app [name] [template] [directory] [options]
This command supports multiple parameter formats:

- **Positional parameters**: `wheels generate app blog` (most common)
- **Named parameters**: `name=value` (e.g., `name=blog`, `template=HelloWorld`)
- **Named parameters**: `name=value` (e.g., `name=blog`, `template=WheelsBaseTemplate`)
- **Flag parameters**: `--flag` equals `flag=true` (e.g., `--useBootstrap` equals `useBootstrap=true`)

**Parameter Mixing Rules:**

**ALLOWED:**
- All positional: `wheels generate app blog`
- All positional + flags: `wheels generate app blog --useBootstrap --init`
- All named: `name=blog template=HelloWorld --useBootstrap`
- All named: `name=blog template=WheelsBaseTemplate --useBootstrap`

**NOT ALLOWED:**
- Positional + named: `wheels generate app blog name=myapp` (causes error)
Expand All @@ -40,7 +40,7 @@ The `wheels generate app` command creates a new Wheels application with a comple
| Argument | Description | Default |
|----------|-------------|---------|
| `name` | Application name | `MyApp` |
| `template` | Template to use | `wheels-base-template@BE` |
| `template` | Template to use | `wheels-base-template@^3.0.0` |
| `directory` | Target directory | `./{name}` |

## Options
Expand All @@ -57,38 +57,54 @@ The `wheels generate app` command creates a new Wheels application with a comple

## Available Templates

### wheels-base-template@BE (Default)
### wheels-base-template@^3.0.0 (stable)
```bash
wheels generate app myapp
```
- Backend Edition default template
- Complete MVC structure with proven, production-ready defaults
- Sample code with minimal, predictable configuration
- H2 database setup by default

### BleedingEdge
```bash
wheels generate app myapp BleedingEdge
```
- Backend Edition template
- Complete MVC structure
- Sample code and configuration
- H2 database setup by default

### HelloWorld
### WheelsStarterApp
```bash
wheels generate app myapp HelloWorld
wheels generate app myapp WheelsStarterApp
```
- Simple "Hello World" example
- One controller and view
- Great for learning

### HelloDynamic
- Starter user management and authentication application built with Wheels 3.0
- Demonstrates best practices for security, conventions, and MVC architecture
- Full authentication & authorization flow (registration, verification, RBAC, admin panel)
- Built-in security features: CSRF protection, audit logging, bcrypt passwords, role checks
- Modern, responsive UI using Bootstrap with Wheels helpers
- Multi-database support with easy setup via CommandBox (MySQL, PostgreSQL, MSSQL, Oracle, H2)

### WheelsTemplateHTMX
```bash
wheels generate app myapp HelloDynamic
wheels generate app myapp WheelsTemplateHTMX
```
- Dynamic content example
- Database interaction
- Form handling

### HelloPages
- Blank starter application for Wheels
- Full MVC structure pre-configured
- htmx integrated for server-side AJAX interactions
- Alpine.js included for lightweight client-side interactivity
- simple.css bundled for clean, minimal styling
- Ready-to-extend layout with sample configuration

### WheelsTodoMVCHTMX
```bash
wheels generate app myapp HelloPages
wheels generate app myapp WheelsTodoMVCHTMX
```
- Static pages example
- Layout system
- Navigation structure
- Reference TodoMVC implementation built with CFWheels
- Uses HTMX for server-driven interactivity
- Demonstrates real-world MVC and CRUD patterns
- Quick setup using CommandBox, CFWheels CLI, and H2

## Examples

Expand Down
Loading