Reference
Look up configuration keys, command-line options, language behavior, and the MCP, R, and Python APIs. For a walkthrough or a task, start with the guides; for application integration, start with Build on Console.
Configuration
Configuration files explains discovery, precedence, merging, paths, and resolved settings. The index below links each setting to its reference section. Dotted paths show nesting; managed Python also accepts package and policy settings under python.managed and in managed fallback candidates.
| Setting | Reference |
|---|---|
cache, cache.directory |
Package cache locations |
environment, inherit_environment |
Shared environment values and inheritance |
languages |
Model-visible languages |
python, python.existing |
Python environment selection |
python.managed, python.version |
Managed Python selection |
python.first_available |
Ordered Python choices |
python.packages, r.packages |
Startup package declarations and defaults |
python.resolution, r.resolution |
Package preparation policies |
r, r.executable |
R installation selection |
r.vanilla |
Native R startup files |
resolver, resolver.environment, resolver.inherit_environment |
Package sources and preparation environment |
resolver.sandbox |
Package preparation permissions |
sandbox |
Session and command permissions |
sandbox.profile |
Base profiles |
sandbox.profile.inherit_codex.fallback |
Fallback when client permissions are unavailable |
sandbox.tempdir |
Temporary storage |
sandbox.filesystem.read_only, sandbox.filesystem.read_write, sandbox.filesystem.deny |
File access |
sandbox.network |
Network choices |
sandbox.network.proxy.mode, sandbox.network.proxy.socks5, sandbox.network.proxy.allow_upstream_proxy |
Proxy settings |
sandbox.network.proxy.domains.allow, sandbox.network.proxy.domains.deny |
Destination rules |
sandbox.network.sockets.unix_sockets, sandbox.network.allow_local_binding |
Local sockets and binding |
startup, startup.language, startup.code |
SQL connection startup |
tool, tool.description, tool.instructions |
Tool descriptions and instructions |
tool.parameters.<name>.enabled, tool.parameters.<name>.description, tool.parameters.<name>.parameters, tool.parameters.<name>.schema |
Tool parameter settings |
The sandbox fields also apply under resolver.sandbox, with the preparation defaults and profile restrictions documented in Package settings.
See Merge rules for omitted, null, and empty values, and Environment variables for recognized variable names.
Behavior
Language behavior specifies R and Python helpers, SQL connections and results, plotting, and output handling. For an introduction, read Sessions and languages.
Recording reference specifies storage locations, files, retention, and failure behavior. For reading and reusing a session, see Recordings and reports.
Interfaces
Command line
- Command-line reference documents command behavior, options, and installation checks.
- CLI help contains the public commands’ complete help text.
MCP
- MCP send reference documents tool arguments, results, output limits, call ordering, and requirements actions.
- Drive send directly is a guide to polling, interactive input, interruption, and restart.
Packages
- The Python API documents synchronous and asynchronous clients and model integrations. Use Console from Python introduces the clients and framework adapters.
- The R API documents tool registration and session configuration. Use Console from R introduces the ellmer integration and links to configuration and analysis examples.
Glossary
The glossary defines terms used throughout Console’s documentation.