Parameters
The VIBE module has 18 parameters in these groups:
- Common
- Code-Server
- JupyterLab
- Node.js
- Claude Code
- Codex CLI
Overview
| Parameter | Type | Level | Default | Description |
|---|---|---|---|---|
vibe_data | path | C | /fs | Workspace dir |
code_enabled | bool | C | true | Enable Code-Server |
code_port | port | C | 8443 | Code-Server port |
code_data | path | C | /data/code | Code-Server data dir |
code_password | string | C | Vibe.Coding | Code-Server password |
code_gallery | enum | C | openvsx | Extension marketplace |
jupyter_enabled | bool | C | false | Enable JupyterLab |
jupyter_port | port | C | 8888 | JupyterLab port |
jupyter_data | path | C | /data/jupyter | JupyterLab data dir |
jupyter_password | string | C | Vibe.Coding | JupyterLab token |
jupyter_venv | path | C | /data/venv | Python venv path |
nodejs_enabled | bool | C | true | Enable Node.js |
nodejs_registry | url | C | '' | npm registry mirror |
npm_packages | string[] | C | [] | Additional global npm packages |
claude_enabled | bool | C | true | Install and configure Claude Code |
claude_package | string | C | @anthropic-ai/claude-code | Claude Code npm package |
claude_env | dict | C | {} | Claude env vars |
codex_enabled | bool | C | true | Install Codex CLI |
Default Parameters
Defined in roles/vibe/defaults/main.yml:
Common
vibe_data
Workspace directory. The default is /fs. Code-Server and JupyterLab use it as their workspace root. The vibe_dir task renders AGENTS.md here and creates a CLAUDE.md symlink to it.
Code-Server
code_enabled
Enable Code-Server, default true.
code_port
Listen port. The default is 8443, bound to 127.0.0.1. Nginx forwards requests through /code/.
code_data
Data dir, config file at code_data/code-server/config.yaml (default /data/code/code-server/config.yaml).
code_password
Login password. The default is Vibe.Coding. You must change it in production.
code_gallery
Extension marketplace: openvsx / microsoft.
If region=china and the marketplace is openvsx, VIBE uses the Tsinghua mirror.
JupyterLab
jupyter_enabled
Enable JupyterLab.
The module default is false. The conf/vibe.yml template explicitly sets it to true for a full sandbox.
jupyter_port
Listen port, default 0.0.0.0:8888.
jupyter_data
Data dir, config file at jupyter_data/jupyter_config.py (default /data/jupyter/jupyter_config.py).
jupyter_password
Access token, default Vibe.Coding, written to c.IdentityProvider.token.
jupyter_venv
Python venv path for JupyterLab. The default is /data/venv. You must create it first, usually through the NODE module.
Node.js
nodejs_enabled
Enable the standalone Node.js installation task, default true.
nodejs_registry
npm registry mirror. If this value is empty and region=china, the default is https://registry.npmmirror.com.
npm_packages
Additional global npm packages, tagged nodejs_pkg; empty by default.
Claude Code and Codex CLI are installed by their own dedicated tasks and do not need to be added here.
Claude Code
claude_enabled
Enable Claude Code installation and configuration. The default is true. The claude_install task installs the CLI. The claude_config task writes its configuration.
claude_package
The npm package used for Claude Code; defaults to @anthropic-ai/claude-code.
claude_env
Extra env vars merged into default OpenTelemetry config.
Default env vars include:
CLAUDE_CODE_ENABLE_TELEMETRY=1OTEL_METRICS_EXPORTER=otlpOTEL_LOGS_EXPORTER=otlpOTEL_EXPORTER_OTLP_METRICS_PROTOCOL=http/protobufOTEL_EXPORTER_OTLP_LOGS_PROTOCOL=http/protobufOTEL_EXPORTER_OTLP_METRICS_ENDPOINT=http://127.0.0.1:8428/opentelemetry/v1/metricsOTEL_EXPORTER_OTLP_LOGS_ENDPOINT=http://127.0.0.1:9428/insert/opentelemetry/v1/logsOTEL_RESOURCE_ATTRIBUTES=ip=<inventory_hostname>,job=claude
Codex CLI
codex_enabled
Specifies whether to install Codex CLI. The default is true. If enabled, codex_install runs npm install -g @openai/codex.
VIBE installs only Codex CLI. It does not manage the Codex configuration or configure OpenTelemetry for Codex.
Was this page helpful?
Thanks—your feedback helps us improve this page.
What got in the way? (optional)