read_file

​

Overview

​

Parameters

​

Returns

​

Cost

​

Text Detection

• Source code: .py, .js, .ts, .go, .rs, .java, .c, .h, .cpp
• Config: .json, .yaml, .yml, .toml, .ini, .cfg, .conf
• Scripts: .sh, .bash, .zsh
• Documentation: .md, .rst, .txt
• Web: .html, .css, .xml

​

Examples

​

Read Configuration File

{
  "tool": "read_file",
  "args": {
    "image": "abc123-def456",
    "path": "/etc/os-release"
  }
}

{
  "path": "/etc/os-release",
  "content": "PRETTY_NAME=\"Debian GNU/Linux 12 (bookworm)\"\nNAME=\"Debian GNU/Linux\"\nVERSION_ID=\"12\"\n...",
  "bytes_size": 187,
  "encoding": "utf-8"
}

​

Check Python Package Version

{
  "tool": "read_file",
  "args": {
    "image": "tag:python:3.11-slim",
    "path": "/usr/local/lib/python3.11/site-packages/pip/__init__.py"
  }
}

​

Review Script Before Execution

// Read the script to understand what it does
{"tool": "read_file", "args": {"image": "img-uuid", "path": "/app/setup.sh"}}

// If safe, execute it
{"tool": "run", "args": {"command": "bash /app/setup.sh", "image": "img-uuid"}}

​

Best Practices

• Prefer over run("cat") - read_file is instant and free
• Review before executing - Check scripts for safety before running
• Inspect configurations - Understand image setup without running commands
• Verify expected content - Check files contain what you expect

​

See Also

• list_files - List directory contents without VM
• download - Download file to local filesystem
• Resources - contree://image/{image}/read/{path} resource alternative