Clarive Commands Reference

Clarive provides a comprehensive command-line interface (CLI) through the cla command. This reference lists all available commands organized by category.

Getting Help¶

cla help                    # Show general help
cla help <command>          # Show help for specific command
cla <command> --help        # Alternative help syntax

Server Management¶

Commands for starting, stopping, and managing Clarive server processes:

cla web-start - Start the web server
cla web-stop - Stop the web server
cla web-restart - Restart the web server
cla disp-start - Start the dispatcher server
cla disp-stop - Stop the dispatcher server
cla disp-restart - Restart the dispatcher server
cla start - Start all Clarive services
cla stop - Stop all Clarive services
cla ps - List running Clarive processes

Configuration & Setup¶

Commands for configuring and setting up Clarive:

cla config - Show or modify configuration settings
cla setup - Initialize a new Clarive configuration
cla lic - License management

Database Operations¶

Commands for database management and maintenance:

cla db-dump - Create database backup
cla db - Database utilities and operations
cla migra - Run database migrations

Development & Testing¶

Commands for development, debugging, and testing:

cla prove - Run test suites
cla repl - Start interactive REPL console
cla exec - Execute commands using Clarive binaries
cla critic - Run code quality checks
cla lint - Check file formatting and standards
cla i18n - Update internationalization files

Rules & Plugins¶

Commands for managing rules and plugins:

cla rule - Rule management operations
cla plugin - Plugin management

Web Server Components¶

Commands for specific web server components:

cla nginx-start - Start Nginx server
cla nginx-stop - Stop Nginx server
cla nginx-restart - Restart Nginx server
cla pubsub - Manage pubsub service
cla proxy - Manage proxy service
cla ws - WebSocket server management

Utilities¶

Various utility commands:

cla info - Display system information
cla version - Show Clarive version
cla passwd - User password management
cla docs - Documentation utilities
cla profile - Performance profiling
cla trans - Transaction utilities
cla queue - Queue management
cla poll - Polling service management
cla keeper - Keeper service management
cla clax - ClaX agent management
cla patch - Apply patches

Common Options¶

Most commands support these common options:

-c, --config <file> - Specify configuration file
--help - Show command help
--verbose - Verbose output
--debug <level> - Set debug level (1-5)

Environment Variables¶

CLARIVE_BASE - Clarive installation directory
CLARIVE_DEBUG - Debug level (1-5)
CLARIVE_TRACE - Enable tracing (e.g., db for database traces)

Examples¶

Start all services for a configuration:

cla start -c myconfig

Run tests for a specific directory:

cla prove t/baseliner/model/

Start web server with debug output:

CLARIVE_DEBUG=3 cla web-start -c myconfig

Create a database backup:

cla db-dump -c myconfig -o backup.gz --compress