CLI Commands
DevProc provides several commands for managing your development environment.
Basic Usage
devproc [options] [command]If no command is specified, up is used by default.
Commands
up (default)
Start all services and launch the TUI.
devproc up# or simplydevprocServices start in dependency order. The TUI remains active for managing services.
down
Stop all running services.
devproc downServices stop in reverse dependency order (dependents stop first).
restart
Restart all services.
devproc restartEquivalent to down followed by up.
status
Show service status without the TUI (non-interactive).
devproc statusOutput:
Service Status PID Uptimepostgres healthy 12345 5mredis healthy 12346 5mapi running 12347 4mworker stopped - -web running 12348 3minit
Create a new devproc.yaml configuration file.
devproc initThis will:
- Detect project name from
package.json - Suggest services based on npm scripts
- Create a commented template
If devproc.yaml already exists, you’ll be prompted to overwrite.
validate
Validate the configuration file without starting services.
devproc validateChecks for:
- Valid YAML syntax
- Required fields
- Valid service references in dependencies
- Valid group references
- Health check configuration
# Validate a specific config filedevproc validate -c ./configs/dev.yamlcompletions
Generate shell completion scripts.
devproc completions <shell>Available shells: bash, zsh, fish
# Generate and install completionseval "$(devproc completions bash)"eval "$(devproc completions zsh)"devproc completions fish | sourceSee Installation for detailed setup instructions.
Options
-c, --config <file>
Specify a custom configuration file.
devproc -c ./configs/development.yamldevproc --config /path/to/devproc.yamlDefault: devproc.yaml in the current directory.
-w, --watch
Watch the config file for changes and auto-reload.
devproc -wdevproc --watchWhen the config file changes:
- New services are added (stopped state)
- Removed services are stopped
- Modified services are restarted
-h, --help
Show help information.
devproc --helpdevproc -h-v, --version
Show version information.
devproc --versiondevproc -vExamples
Start with Default Config
cd my-projectdevprocStart with Custom Config
devproc -c ./docker/devproc.yamlStart with Auto-Reload
devproc -wCheck Config Before Running
devproc validate && devprocGenerate Starter Config
cd my-projectdevproc initdevproc validatedevprocNon-Interactive Status Check
# Great for scriptsdevproc statusExit Codes
| Code | Meaning |
|---|---|
| 0 | Success |
| 1 | General error |
| 2 | Configuration error |
| 130 | Interrupted (Ctrl+C) |
Environment Variables
LOG_LEVEL
Set internal logging level.
LOG_LEVEL=debug devprocValues: debug, info, warn, error
LOG_FILE
Write internal logs to a file.
LOG_FILE=/tmp/devproc.log devprocUseful for debugging DevProc itself without cluttering the TUI.