Running Local Development Servers

Beginner Tutorial: Hello World

Beginner Tutorial: Hello Database

Tutorial: Wheels, AJAX, and You

Frameworks and Wheels

Requirements

Manual Installation

Upgrading

Screencasts

CLI Overview

Quick Start Guide

wheels info

wheels reload

wheels deps

wheels destroy

wheels watch

wheels generate app

wheels generate app-wizard

wheels generate controller

wheels generate model

wheels generate view

wheels generate property

wheels generate route

wheels generate resource

wheels generate api-resource

wheels generate frontend

wheels generate test

wheels generate snippets

wheels scaffold

wheels db create

wheels db drop

wheels db setup

wheels db reset

wheels db status

wheels db version

wheels db rollback

wheels db seed

wheels db dump

wheels db restore

wheels db shell

wheels db schema

wheels dbmigrate info

wheels dbmigrate latest

wheels dbmigrate up

wheels dbmigrate down

wheels dbmigrate reset

wheels dbmigrate exec

wheels dbmigrate create blank

wheels dbmigrate create table

wheels dbmigrate create column

wheels dbmigrate remove table

wheels test

wheels test run

wheels test coverage

wheels test debug

wheels config list

wheels config set

wheels config env

wheels env

wheels env setup

wheels env list

wheels env switch

wheels environment

wheels console

wheels runner

wheels server

wheels server start

wheels server stop

wheels server restart

wheels server status

wheels server log

wheels server open

wheels plugins

wheels plugins list

wheels plugins install

wheels plugins remove

wheels analyze

wheels analyze code

wheels analyze performance

wheels analyze security

wheels security

wheels security scan

wheels optimize

wheels optimize performance

wheels docs

wheels docs generate

wheels docs serve

wheels ci init

wheels docker init

wheels docker deploy

wheels deploy

wheels deploy audit

wheels deploy exec

wheels deploy hooks

wheels deploy init

wheels deploy lock

wheels deploy logs

wheels deploy proxy

wheels deploy push

wheels deploy rollback

wheels deploy secrets

wheels deploy setup

wheels deploy status

wheels deploy stop

Configuration Management

Creating Commands

Service Architecture

Migrations Guide

Testing Guide

Conventions

Configuration and Defaults

Directory Structure

Switching Environments

Testing Your Application

Using the Test Environment

Contributing to Wheels

Submitting Pull Requests

Documenting your Code

Request Handling

Rendering Content

Redirecting Users

Sending Files

Sending Email

Responding with Multiple Formats

Using the Flash

Using Filters

Verification

Event Handlers

Routing

Apache

IIS

Tomcat

Nginx

Obfuscating URLs

Caching

Nesting Controllers

CORS Requests

Pages

Partials

Linking Pages

Layouts

Form Helpers and Showing Errors

Displaying Links for Pagination

Date, Media, and Text Helpers

Creating Custom View Helpers

Localization

Object Relational Mapping

Creating Records

Reading Records

Updating Records

Deleting Records

Column Statistics

Dynamic Finders

Getting Paginated Data

Associations

Nested Properties

Object Validation

Object Callbacks

Calculated Properties

Transactions

Dirty Records

Soft Delete

Automatic Time Stamps

Migrations in Production

Using Multiple Data Sources

Installing and Using Plugins

Developing Plugins

Publishing Plugins

Overview

Source Code

Issue Tracker

Sponsor Us

Community
Ask or search...
Ctrl K

wheels server start (Coming Soon)

This command may not work as expected. A complete and stable version is coming soon.

Start the Wheels development server with enhanced checks and features.

Synopsis

wheels server start [options]

Description

The wheels server start command starts a CommandBox server with Wheels-specific enhancements. It checks that you're in a valid Wheels application directory before starting and provides helpful error messages if not.

This command wraps CommandBox's native server start functionality while adding:

  • Validation that the current directory is a Wheels application
  • Automatic detection of existing running servers
  • Wheels-specific configuration suggestions
  • Integration with Wheels application context

Options

port

  • Type: Numeric
  • Description: Port number to start server on
  • Example: wheels server start port=8080

host

  • Type: String
  • Default: 127.0.0.1
  • Description: Host/IP address to bind server to
  • Example: wheels server start host=0.0.0.0

--rewritesEnable

  • Type: Boolean flag
  • Description: Enable URL rewriting for clean URLs
  • Example: wheels server start --rewritesEnable

openbrowser

  • Type: Boolean
  • Default: true
  • Description: Open browser after starting server
  • Example: wheels server start openbrowser=false

directory

  • Type: String
  • Default: Current working directory
  • Description: Directory to serve
  • Example: wheels server start directory=/path/to/app

name

  • Type: String
  • Description: Name for the server instance
  • Example: wheels server start name=myapp

--force

  • Type: Boolean flag
  • Description: Force start even if server is already running
  • Example: wheels server start --force

Examples

Basic Usage

# Start server with defaults
wheels server start

# Start on specific port
wheels server start port=3000

# Start without opening browser
wheels server start openbrowser=false

Advanced Usage

# Start with multiple options
wheels server start port=8080 host=0.0.0.0 --rewritesEnable

# Start with custom name
wheels server start name=myapp port=8080

# Force restart if already running
wheels server start --force

Notes

  • The command validates that the current directory contains a Wheels application by checking for /vendor/wheels, /config, and /app directories
  • If a server is already running, use --force to start anyway or wheels server restart to restart
  • After starting, the command displays helpful information about other server commands
  • The server configuration can also be managed through server.json file

See Also