Skip to content

cli.md

Latest commit

 

History

History
157 lines (112 loc) · 3.64 KB

cli.md

File metadata and controls

157 lines (112 loc) · 3.64 KB

CLI Reference

Commands

mycel start

Start the Mycel runtime with the given configuration.

mycel start [flags]
Flag Default Description
--config, -c . (current directory) Path to the config directory
--env development Environment name (overrides MYCEL_ENV)
--log-level info Log level: debug, info, warn, error
--log-format text Log format: text or json
--mock — Enable mock for specific connector (repeatable)
--no-mock — Disable mock for specific connector (repeatable)

Examples:

# Start with current directory as config
mycel start

# Start with specific config directory
mycel start --config ./my-service

# Start in production mode
mycel start --env production --log-format json

# Start with all connectors mocked
mycel start --mock=db --mock=external_api

# Start with all mocks except payment service
mycel start --no-mock=stripe

mycel validate

Validate configuration files without starting the service. Reports HCL syntax errors, undefined references, and expression compilation errors.

mycel validate [flags]
Flag Default Description
--config, -c . Path to the config directory

Example:

mycel validate --config ./my-service
# Config validation successful: 2 connectors, 5 flows, 3 types

mycel check

Check connectivity to all configured connectors. Useful before deployment to verify all services are reachable.

mycel check [flags]
Flag Default Description
--config, -c . Path to the config directory

Example:

mycel check --config ./my-service
# ✓ postgres: connected
# ✓ redis: connected
# ✗ external_api: connection refused

mycel version

Print the Mycel version.

mycel version
# mycel v1.7.0 (go1.21)

mycel export

Export auto-generated API documentation.

mycel export openapi [flags]     # Export OpenAPI 3.0 spec
mycel export graphql-schema [flags]  # Export GraphQL SDL
mycel export asyncapi [flags]    # Export AsyncAPI spec
Flag Default Description
--config, -c . Path to the config directory
--output, -o stdout Output file path

Examples:

# Export OpenAPI spec to file
mycel export openapi --config ./my-service --output openapi.json

# Export GraphQL schema
mycel export graphql-schema --output schema.graphql

mycel plugin

Manage WASM plugins.

mycel plugin install              # Install all declared plugins
mycel plugin list                 # List installed plugins
mycel plugin remove <name>        # Remove a plugin
mycel plugin update               # Update all plugins to latest compatible versions

Examples:

mycel plugin install
# Installing salesforce v1.2.0... done
# Installing stripe v3.0.1... done

mycel plugin list
# NAME          VERSION  SOURCE
# salesforce    1.2.0    github.com/acme/mycel-salesforce
# stripe        3.0.1    github.com/acme/mycel-stripe

mycel plugin remove salesforce

Environment Variables

Variable Default Description
MYCEL_ENV development Environment name
MYCEL_LOG_LEVEL info Log level
MYCEL_LOG_FORMAT text Log format
NO_COLOR unset Disable colored output
MYCEL_PLUGIN_CACHE unset Plugin cache directory

CLI flags take precedence over environment variables.

Priority Chain

CLI flags > env vars > .env file > defaults