CLI Reference
Complete reference for all DevEx CLI commands, flags, and options
DevEx CLI Reference
The DevEx CLI provides a comprehensive suite of commands for managing your development environment. This reference covers all available commands, their options, and usage patterns.
DevEx follows the Unix philosophy of composable tools. Each command has a specific purpose and can be combined with others for powerful workflows.
Command Overview
devex setup- Interactive guided setupdevex install- Install development environmentdevex add- Add new applicationsdevex remove- Remove applications
Basic Usage
Getting Started
# Start with the interactive setup
devex setup
# Or install everything with defaults
devex install
# Check what's installed
devex statusCommon Workflows
Initial Setup: Use devex setup for first-time configuration
Add Tools: Use devex add <application> to install additional software
Configure: Use devex config to customize your environment
Maintain: Use devex status and devex recovery for ongoing maintenance
Global Flags
All DevEx commands support these global flags:
| Flag | Short | Description | Default |
|---|---|---|---|
--verbose | -v | Enable verbose output | false |
--dry-run | -n | Show what would be done without executing | false |
--config-dir | Override default config directory | ~/.local/share/devex/config | |
--help | -h | Show command help |
Examples
# Verbose installation
devex install --verbose
# Dry-run to see what would be installed
devex add docker --dry-run
# Use custom config directory
devex install --config-dir ./custom-configsEnvironment Variables
DevEx recognizes these environment variables:
| Variable | Description | Default |
|---|---|---|
DEVEX_DEBUG | Enable debug logging | false |
DEVEX_CONFIG_DIR | Override config directory | ~/.local/share/devex/config |
DEVEX_NO_COLOR | Disable colored output | false |
DEVEX_CACHE_DIR | Override cache directory | ~/.cache/devex |
Exit Codes
DevEx commands return standard exit codes:
- 0: Success
- 1: General error
- 2: Invalid arguments or options
- 3: Configuration error
- 4: Installation error
- 5: Platform not supported
Output Formats
Many commands support different output formats:
devex status
# ✓ git (installed via apt)
# ✓ docker (installed via apt)
# ✗ node (not installed)Performance Tips
- Use
--dry-runto preview changes before execution - Enable
--verbosefor detailed operation logging - Use specific commands instead of running full
installfor single applications - Set
DEVEX_CACHE_DIRto a fast storage location for better performance
Security Considerations
DevEx includes several security features:
- Input validation: All user inputs are validated and sanitized
- Privilege escalation: Only prompts for sudo when necessary
- GPG verification: Package signatures are verified when available
- Audit trail: All operations are logged for review
DevEx may require administrator privileges for system-level installations. Always review --dry-run output before executing privileged operations.
Getting Help
For detailed help on any command:
# Command-specific help
devex <command> --help
# Interactive help system
devex help
# Version information
devex --versionNext Steps
- Setup Command Reference - Start with the interactive setup
- Configuration Guide - Learn about configuration files
- Platform Support - Check platform-specific features