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
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
Using Multiple Data Sources
docs serve (Coming Soon)
This command may not work as expected. A complete and stable version is coming soon.
Serves generated documentation locally for development and review.
Usage
wheels docs serve [--root=<dir>] [--port=<port>] [--open] [--watch]
Parameters
--root- (Optional) Root directory to serve. Default:docs/api--port- (Optional) Port to serve on. Default:35729--open- (Optional) Open browser automatically. Default:true--watch- (Optional) Watch for changes and regenerate. Default:false
Description
The docs serve command starts a local web server to preview your generated documentation. It includes:
- Live reload on documentation changes
- Search functionality
- Responsive design preview
- Print-friendly styling
- Offline access support
Examples
Basic documentation server
wheels docs serve
Serve on different port
wheels docs serve --port=8080
Serve from custom directory
wheels docs serve --root=public/api-docs
Serve with file watching
wheels docs serve --watch
Serve without opening browser
wheels docs serve --open=false
Custom configuration
wheels docs serve --root=docs/generated --port=3000 --watch
Server Output
🌐 Starting documentation server...
Server started successfully!
- URL: http://localhost:35729
- Root: /docs/api
- Auto-open: enabled
Press Ctrl+C to stop the server
If documentation is not found:
Documentation directory not found: /docs/api
💡 Tip: Run 'wheels docs generate' first to create documentation
Features
File Watching
When --watch is enabled, the server monitors documentation files for changes and can trigger regeneration.
Browser Integration
With --open=true (default), the server automatically opens your default browser to the documentation URL.
Development Workflow
Typical usage:
# Step 1: Generate documentation
wheels docs generate
# Step 2: Serve documentation
wheels docs serve
# Step 3: Make changes and regenerate
wheels docs generate
# Browser will show updated docs
Custom workflow:
# Generate and serve from custom location
wheels docs generate --output=public/docs
wheels docs serve --root=public/docs --port=8080
Troubleshooting
Port already in use
# Use a different port
wheels docs serve --port=8081
Documentation not found
# Make sure to generate docs first
wheels docs generate
wheels docs serve
Browser doesn't open
# Manually navigate to the URL shown
# Or check your default browser settings
Notes
- Server is intended for development/review only
- For production, deploy static files to web server
- Large documentation sets may take time to generate
- Browser must support JavaScript for search
- Offline mode caches documentation locally
- Usage
- Parameters
- Examples
- Basic documentation server
- Serve on different port
- Serve from custom directory
- Serve with file watching
- Serve without opening browser
- Custom configuration
- Server Output
- Features
- File Watching
- Browser Integration
- Development Workflow
- Typical usage:
- Custom workflow:
- Troubleshooting
- Port already in use
- Documentation not found
- Browser doesn't open
- Notes