Skip to content

input

The input block defines an external input parameter for your Orca project.

Syntax

orca
input <name> {
  type      = <type>
  desc      = <string>   // optional
  default   = <value>    // optional
  sensitive = <bool>     // optional
}

Fields

FieldTypeRequiredDescription
typeschemaYesThe type of the input (primitive, schema reference, or inline schema)
descstr | nullNoDescription of the input
defaultany | nullNoDefault value if not provided at runtime
sensitivebool | nullNoWhether this input contains sensitive data (e.g., API keys)

Examples

Simple input

orca
input api_key {
  type      = str
  desc      = "OpenAI API key"
  sensitive = true
}

Input with a schema type

orca
schema vpc_config {
  region = str
  cidr   = str
}

input network {
  type    = vpc_config
  desc    = "VPC configuration for deployment"
}

Input with inline schema

orca
input config {
  type = schema {
    region   = str
    replicas = int
    debug    = bool | null
  }
  desc = "Runtime configuration"
}

Released under the MIT License.