ostruct-cli

📚 Getting Started

  • Introduction to ostruct
  • Quick Start Guide
  • Data Science Integration Guide
  • Overview
  • Jupyter/Colab Integration
  • Interactive Jupyter Notebook Example
  • Multi-Tool Data Science Workflows
  • Comprehensive Multi-Tool Workflow Patterns
  • Data Science Schema Templates
  • Practical Examples and Use Cases
  • Token Management for Large Datasets
  • Error Handling and Troubleshooting
  • Performance Optimization
  • Practical Examples and Use Cases
  • Integration with Data Science Tools
  • Next Steps
  • See Also
  • Examples and Use Cases
  • Development Tools
  • Available Examples
  • Getting Started with Examples
  • Contributing Examples
  • Next Steps

📝 Templates

  • Template Guide
  • Understanding Templates
  • Variables and Data Access
  • File Variables
  • File Attachment System
  • Directory Variables
  • Literal and JSON Variables
  • Template Filters
  • Template Functions
  • Control Structures
  • YAML Frontmatter
  • Template Debugging
  • Best Practices
  • Real-World Examples
  • See Also
  • Template Quick Reference
  • Template Structure
  • Essential Syntax
  • File Variables
  • Tool Variables
  • Standard Input
  • CLI Variables
  • Essential Filters
  • Common Patterns
  • Global Functions
  • File Operations
  • Common Issues
  • CLI Examples
  • Advanced Template Patterns
  • Template Organization
  • Multi-Tool Integration Patterns
  • Remote PDF Analysis with Vision Models
  • Dynamic Content Generation
  • Performance Optimization
  • Error Handling and Robustness
  • Template Composition Patterns
  • Best Practices Summary
  • See Also

🔧 Reference

  • CLI Reference
  • OST (Self-Executing Templates) Commands
  • Template Scaffolding Commands
  • Environment Setup Commands
  • Attachment System
  • Usage Examples
  • File Attachment Helpers
  • File Type Limitations
  • Other Options
  • Troubleshooting
  • Files Management Commands
  • See Also
  • OST Front-matter Reference Guide
  • What are OST Files?
  • OST File Structure
  • Required Sections
  • CLI Configuration
  • Action Parameters
  • CLI-Level Global Arguments
  • File Routing Targets
  • Validation and Choices
  • Default Values
  • Global Arguments Policy
  • Global Flags
  • Complete Example
  • Usage Examples
  • Best Practices
  • Common Patterns
  • Troubleshooting
  • See Also
  • Validation Rules Reference
  • Argument Parsing Rules
  • Argument Parsing Tips
  • Upload Cache Guide
  • Error Handling
  • Gitignore Support Guide
  • Multi-Tool Integration
  • Code Interpreter
  • File Search
  • Web Search
  • MCP Servers
  • Multi-Tool Workflows
  • Configuration Management
  • Troubleshooting
  • See Also

🚀 Automation

  • CI/CD and Container Deployment
  • CI/CD Integration
  • GitHub Actions
  • GitLab CI
  • Container Deployment
  • Docker Fundamentals
  • Creating Custom Docker Images
  • Docker Compose Deployments
  • Kubernetes Deployment
  • Security Best Practices
  • Best Practices Summary
  • Scripting and Cost Control
  • Batch Processing Patterns
  • Cost Control and Optimization
  • Budget Controls
  • Best Practices Summary

🛠️ Contributing

  • How to Contribute
  • Style Guide
  • Release & Hot-Fix Workflow
  • Examples Standard

🔒 Security

  • Security Overview
  • Security Architecture
  • API Key Management
  • File Access Control
  • URL Validation & Remote Attachments
  • User-Data (Vision Model) Uploads
  • Data Upload and Tool Security
  • MCP Server Security
  • Threat Model and Risk Assessment
  • Production Security Checklist
  • Security Configuration Examples
  • Security Resources
  • Getting Security Help
ostruct-cli
  • Search

© Copyright 2025, Yaniv Golan.

Built with Sphinx using a theme provided by Read the Docs.