User Guides

Practical guides for building, deploying, and managing applications with bfabric-app-runner.

• Creating an App
  • App Specification
  • Multi-Version Support
  • Command Types
  • Commands Spec
  • Development Version
  • Validation
• Deploying Apps
  • Build Process
  • Deploying to the Server
  • Referencing in app.yml
  • Validation
  • Checklist
• Working with Inputs
  • Overview
  • Input YAML Format
  • Input Spec Types
  • Resolution Pipeline
  • CLI Commands
  • Filtering
  • Validating Input Specs
• Working with Outputs
  • Overview
  • Output YAML Format
  • Output Spec Types
  • UpdateExisting Behavior
  • CLI Commands
  • Validating Output Specs
• Python Environments
  • Overview
  • Cached Environments
  • Ephemeral Environments
  • Provisioning Process
  • Environment Structure
  • Path Management
  • Configuration Example
  • When to Use Refresh Mode
• CLI Reference
  • run
  • prepare
  • action
  • inputs
  • outputs
  • validate

Guides Overview

Guide	Description	Skill Level
Creating an App	Define app specs, versions, and commands	Beginner
Deploying Apps	Build and deploy Python apps with uv	Intermediate
Working with Inputs	Resolve and prepare input files for app execution	Intermediate
Working with Outputs	Register output files and datasets in B-Fabric	Intermediate
Python Environments	Cached and ephemeral environment management	Advanced
CLI Reference	Complete command-line reference	All Levels

Common Workflows

• App Specification - Define your app in YAML

• Input Preparation - Download and prepare inputs

• Output Registration - Register results in B-Fabric

• Quick CLI Reference - All available commands at a glance