The apicentric CLI provides a comprehensive set of commands for managing API mocks, simulations, and testing workflows.
Global flags
These flags are available for all commands:
--config
string
default:"apicentric.json"
Path to the apicentric configuration file
Execution mode that overrides the config file. Valid values:
ci - Optimized for continuous integration environmentsdevelopment - Development mode with detailed loggingdebug - Maximum verbosity for troubleshooting
Show what would be executed without making any changes
Enable verbose output for detailed logging
--db-path
string
default:"apicentric.db"
Path to the SQLite database for simulator storage
Available commands
Core commands
simulator
Start, stop, and manage API mock services
doctor
Check your system for potential issues
ai
Generate API services using AI
tui
Launch interactive terminal dashboard
Utility commands
new
Create a new service definition interactively
open
Open the WebUI in your default browser
Advanced commands
mcp
Start the Model Context Protocol server
twin
Run IoT digital twin simulations
Usage patterns
Basic execution
apicentric <command> [subcommand] [flags]
With global flags
apicentric --config my-config.json --verbose simulator start
Dry run mode
Test commands without executing them:
apicentric --dry-run simulator start --services-dir ./services
Quick command reference
new
Create a new service definition interactively with a guided wizard.
apicentric new <name> [--template <template>]
# Create with default template
apicentric new my-api
# Create with specific template
apicentric new my-api --template rest
Use apicentric simulator new for a file-based approach or apicentric new for the interactive wizard.
open
Open the WebUI in your default browser.
apicentric open [--port <port>]
# Open WebUI on default port
apicentric open
# Open WebUI on specific port
apicentric open --port 9002
Next steps
Explore the detailed documentation for each command to learn about all available options and use cases.