Skip to content

Parameters

VIBE module parameters (18 total).

The VIBE module has 18 parameters in these groups:

  • Common
  • Code-Server
  • JupyterLab
  • Node.js
  • Claude Code
  • Codex CLI

Overview

ParameterTypeLevelDefaultDescription
vibe_datapathC/fsWorkspace dir
code_enabledboolCtrueEnable Code-Server
code_portportC8443Code-Server port
code_datapathC/data/codeCode-Server data dir
code_passwordstringCVibe.CodingCode-Server password
code_galleryenumCopenvsxExtension marketplace
jupyter_enabledboolCfalseEnable JupyterLab
jupyter_portportC8888JupyterLab port
jupyter_datapathC/data/jupyterJupyterLab data dir
jupyter_passwordstringCVibe.CodingJupyterLab token
jupyter_venvpathC/data/venvPython venv path
nodejs_enabledboolCtrueEnable Node.js
nodejs_registryurlC''npm registry mirror
npm_packagesstring[]C[]Additional global npm packages
claude_enabledboolCtrueInstall and configure Claude Code
claude_packagestringC@anthropic-ai/claude-codeClaude Code npm package
claude_envdictC{}Claude env vars
codex_enabledboolCtrueInstall Codex CLI

Default Parameters

Defined in roles/vibe/defaults/main.yml:

vibe_data: /fs

code_enabled: true
code_port: 8443
code_data: /data/code
code_password: Vibe.Coding
code_gallery: 'openvsx'

jupyter_enabled: false
jupyter_port: 8888
jupyter_data: /data/jupyter
jupyter_password: Vibe.Coding
jupyter_venv: /data/venv

nodejs_enabled: true
nodejs_registry: ''
npm_packages: []

claude_enabled: true
claude_package: '@anthropic-ai/claude-code'
claude_env: {}

codex_enabled: true

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.

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=1
  • OTEL_METRICS_EXPORTER=otlp
  • OTEL_LOGS_EXPORTER=otlp
  • OTEL_EXPORTER_OTLP_METRICS_PROTOCOL=http/protobuf
  • OTEL_EXPORTER_OTLP_LOGS_PROTOCOL=http/protobuf
  • OTEL_EXPORTER_OTLP_METRICS_ENDPOINT=http://127.0.0.1:8428/opentelemetry/v1/metrics
  • OTEL_EXPORTER_OTLP_LOGS_ENDPOINT=http://127.0.0.1:9428/insert/opentelemetry/v1/logs
  • OTEL_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?