Env
The Env type represents an environment consisting of inputs and desired outputs, for use by an LLM. For example, an environment might provide a Directory, a Container, a custom module, and a string variable as inputs, and request a Container as output.
API reference
Implements Node
id- A unique identifier for this Env.
check- Return the check with the given name from the installed modules. Must match exactly one check.
checks- Return all checks defined by the installed modules
input- Retrieves an input binding by name
inputs- Returns all input bindings provided to the environment
output- Retrieves an output binding by name
outputs- Returns all declared output bindings for the environment
services- Return all services defined by the installed modules
withAddressInput- Create or update a binding of type Address in the environment
withAddressOutput- Declare a desired Address output to be assigned in the environment
withCacheVolumeInput- Create or update a binding of type CacheVolume in the environment
withCacheVolumeOutput- Declare a desired CacheVolume output to be assigned in the environment
withChangesetInput- Create or update a binding of type Changeset in the environment
withChangesetOutput- Declare a desired Changeset output to be assigned in the environment
withCheckGroupInput- Create or update a binding of type CheckGroup in the environment
withCheckGroupOutput- Declare a desired CheckGroup output to be assigned in the environment
withCheckInput- Create or update a binding of type Check in the environment
withCheckOutput- Declare a desired Check output to be assigned in the environment
withCloudInput- Create or update a binding of type Cloud in the environment
withCloudOutput- Declare a desired Cloud output to be assigned in the environment
withContainerInput- Create or update a binding of type Container in the environment
withContainerOutput- Declare a desired Container output to be assigned in the environment
withCurrentModule- Installs the current module into the environment, exposing its functions to the model
withCurrentModuleAsSDKClientInput- Create or update a binding of type CurrentModuleAsSDKClient in the environment
withCurrentModuleAsSDKClientOutput- Declare a desired CurrentModuleAsSDKClient output to be assigned in the environment
withCurrentModuleAsSDKInput- Create or update a binding of type CurrentModuleAsSDK in the environment
withCurrentModuleAsSDKModuleInput- Create or update a binding of type CurrentModuleAsSDKModule in the environment
withCurrentModuleAsSDKModuleOutput- Declare a desired CurrentModuleAsSDKModule output to be assigned in the environment
withCurrentModuleAsSDKOutput- Declare a desired CurrentModuleAsSDK output to be assigned in the environment
withDiffStatInput- Create or update a binding of type DiffStat in the environment
withDiffStatOutput- Declare a desired DiffStat output to be assigned in the environment
withDirectoryInput- Create or update a binding of type Directory in the environment
withDirectoryOutput- Declare a desired Directory output to be assigned in the environment
withEnvFileInput- Create or update a binding of type EnvFile in the environment
withEnvFileOutput- Declare a desired EnvFile output to be assigned in the environment
withEnvInput- Create or update a binding of type Env in the environment
withEnvOutput- Declare a desired Env output to be assigned in the environment
withFileInput- Create or update a binding of type File in the environment
withFileOutput- Declare a desired File output to be assigned in the environment
withGeneratorGroupInput- Create or update a binding of type GeneratorGroup in the environment
withGeneratorGroupOutput- Declare a desired GeneratorGroup output to be assigned in the environment
withGeneratorInput- Create or update a binding of type Generator in the environment
withGeneratorOutput- Declare a desired Generator output to be assigned in the environment
withGitRefInput- Create or update a binding of type GitRef in the environment
withGitRefOutput- Declare a desired GitRef output to be assigned in the environment
withGitRepositoryInput- Create or update a binding of type GitRepository in the environment
withGitRepositoryOutput- Declare a desired GitRepository output to be assigned in the environment
withHTTPStateInput- Create or update a binding of type HTTPState in the environment
withHTTPStateOutput- Declare a desired HTTPState output to be assigned in the environment
withJSONValueInput- Create or update a binding of type JSONValue in the environment
withJSONValueOutput- Declare a desired JSONValue output to be assigned in the environment
withMainModule- Sets the main module for this environment (the project being worked on)
withModule- Installs a module into the environment, exposing its functions to the model
withModuleConfigClientInput- Create or update a binding of type ModuleConfigClient in the environment
withModuleConfigClientOutput- Declare a desired ModuleConfigClient output to be assigned in the environment
withModuleInput- Create or update a binding of type Module in the environment
withModuleOutput- Declare a desired Module output to be assigned in the environment
withModuleSourceInput- Create or update a binding of type ModuleSource in the environment
withModuleSourceOutput- Declare a desired ModuleSource output to be assigned in the environment
withoutOutputs- Returns a new environment without any outputs
withSearchResultInput- Create or update a binding of type SearchResult in the environment
withSearchResultOutput- Declare a desired SearchResult output to be assigned in the environment
withSearchSubmatchInput- Create or update a binding of type SearchSubmatch in the environment
withSearchSubmatchOutput- Declare a desired SearchSubmatch output to be assigned in the environment
withSecretInput- Create or update a binding of type Secret in the environment
withSecretOutput- Declare a desired Secret output to be assigned in the environment
withServiceInput- Create or update a binding of type Service in the environment
withServiceOutput- Declare a desired Service output to be assigned in the environment
withSocketInput- Create or update a binding of type Socket in the environment
withSocketOutput- Declare a desired Socket output to be assigned in the environment
withStatInput- Create or update a binding of type Stat in the environment
withStatOutput- Declare a desired Stat output to be assigned in the environment
withStringInput- Provides a string input binding to the environment
withStringOutput- Declares a desired string output binding
withUpGroupInput- Create or update a binding of type UpGroup in the environment
withUpGroupOutput- Declare a desired UpGroup output to be assigned in the environment
withUpInput- Create or update a binding of type Up in the environment
withUpOutput- Declare a desired Up output to be assigned in the environment
withWorkspace- Returns a new environment with the provided workspace
withWorkspaceGitInput- Create or update a binding of type WorkspaceGit in the environment
withWorkspaceGitOutput- Declare a desired WorkspaceGit output to be assigned in the environment
withWorkspaceInput- Create or update a binding of type Workspace in the environment
withWorkspaceMigrationInput- Create or update a binding of type WorkspaceMigration in the environment
withWorkspaceMigrationOutput- Declare a desired WorkspaceMigration output to be assigned in the environment
withWorkspaceMigrationStepInput- Create or update a binding of type WorkspaceMigrationStep in the environment
withWorkspaceMigrationStepOutput- Declare a desired WorkspaceMigrationStep output to be assigned in the environment
withWorkspaceModuleInput- Create or update a binding of type WorkspaceModule in the environment
withWorkspaceModuleOutput- Declare a desired WorkspaceModule output to be assigned in the environment
withWorkspaceModuleSettingInput- Create or update a binding of type WorkspaceModuleSetting in the environment
withWorkspaceModuleSettingOutput- Declare a desired WorkspaceModuleSetting output to be assigned in the environment
withWorkspaceOutput- Declare a desired Workspace output to be assigned in the environment
workspace
id: ID!
A unique identifier for this Env.
check(name: String!): Check!Experimental
Return the check with the given name from the installed modules. Must match exactly one check.
Experimental: Checks API is highly experimental and may be removed or replaced entirely.
name: String!The name of the check to retrieve
checks(include: [String!], noGenerate: Boolean): CheckGroup!Experimental
Return all checks defined by the installed modules
Experimental: Checks API is highly experimental and may be removed or replaced entirely.
include: [String!]Only include checks matching the specified patterns
noGenerate: BooleanWhen true, only return annotated check functions; exclude generate-as-checks
services(include: [String!]): UpGroup!Experimental
Return all services defined by the installed modules
Experimental: Services API is highly experimental and may be removed or replaced entirely.
include: [String!]Only include services matching the specified patterns
withAddressInput(name: String!,value: Address!,description: String!): Env!
Create or update a binding of type Address in the environment
name: String!The name of the binding
value: Address!The Address value to assign to the binding
description: String!The purpose of the input
withAddressOutput(name: String!, description: String!): Env!
Declare a desired Address output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withCacheVolumeInput(name: String!,value: CacheVolume!,description: String!): Env!
Create or update a binding of type CacheVolume in the environment
name: String!The name of the binding
value: CacheVolume!The CacheVolume value to assign to the binding
description: String!The purpose of the input
withCacheVolumeOutput(name: String!, description: String!): Env!
Declare a desired CacheVolume output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withChangesetInput(name: String!,value: Changeset!,description: String!): Env!
Create or update a binding of type Changeset in the environment
name: String!The name of the binding
value: Changeset!The Changeset value to assign to the binding
description: String!The purpose of the input
withChangesetOutput(name: String!, description: String!): Env!
Declare a desired Changeset output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withCheckGroupInput(name: String!,value: CheckGroup!,description: String!): Env!
Create or update a binding of type CheckGroup in the environment
name: String!The name of the binding
value: CheckGroup!The CheckGroup value to assign to the binding
description: String!The purpose of the input
withCheckGroupOutput(name: String!, description: String!): Env!
Declare a desired CheckGroup output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withCheckInput(name: String!,value: Check!,description: String!): Env!
Create or update a binding of type Check in the environment
name: String!The name of the binding
value: Check!The Check value to assign to the binding
description: String!The purpose of the input
withCheckOutput(name: String!, description: String!): Env!
Declare a desired Check output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withCloudInput(name: String!,value: Cloud!,description: String!): Env!
Create or update a binding of type Cloud in the environment
name: String!The name of the binding
value: Cloud!The Cloud value to assign to the binding
description: String!The purpose of the input
withCloudOutput(name: String!, description: String!): Env!
Declare a desired Cloud output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withContainerInput(name: String!,value: Container!,description: String!): Env!
Create or update a binding of type Container in the environment
name: String!The name of the binding
value: Container!The Container value to assign to the binding
description: String!The purpose of the input
withContainerOutput(name: String!, description: String!): Env!
Declare a desired Container output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withCurrentModule: Env!
Installs the current module into the environment, exposing its functions to the model
Contextual path arguments will be populated using the environment's workspace.
withCurrentModuleAsSDKClientInput(name: String!,value: CurrentModuleAsSDKClient!,description: String!): Env!
Create or update a binding of type CurrentModuleAsSDKClient in the environment
name: String!The name of the binding
value: CurrentModuleAsSDKClient!The CurrentModuleAsSDKClient value to assign to the binding
description: String!The purpose of the input
withCurrentModuleAsSDKClientOutput(name: String!, description: String!): Env!
Declare a desired CurrentModuleAsSDKClient output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withCurrentModuleAsSDKInput(name: String!,value: CurrentModuleAsSDK!,description: String!): Env!
Create or update a binding of type CurrentModuleAsSDK in the environment
name: String!The name of the binding
value: CurrentModuleAsSDK!The CurrentModuleAsSDK value to assign to the binding
description: String!The purpose of the input
withCurrentModuleAsSDKModuleInput(name: String!,value: CurrentModuleAsSDKModule!,description: String!): Env!
Create or update a binding of type CurrentModuleAsSDKModule in the environment
name: String!The name of the binding
value: CurrentModuleAsSDKModule!The CurrentModuleAsSDKModule value to assign to the binding
description: String!The purpose of the input
withCurrentModuleAsSDKModuleOutput(name: String!, description: String!): Env!
Declare a desired CurrentModuleAsSDKModule output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withCurrentModuleAsSDKOutput(name: String!, description: String!): Env!
Declare a desired CurrentModuleAsSDK output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withDiffStatInput(name: String!,value: DiffStat!,description: String!): Env!
Create or update a binding of type DiffStat in the environment
name: String!The name of the binding
value: DiffStat!The DiffStat value to assign to the binding
description: String!The purpose of the input
withDiffStatOutput(name: String!, description: String!): Env!
Declare a desired DiffStat output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withDirectoryInput(name: String!,value: Directory!,description: String!): Env!
Create or update a binding of type Directory in the environment
name: String!The name of the binding
value: Directory!The Directory value to assign to the binding
description: String!The purpose of the input
withDirectoryOutput(name: String!, description: String!): Env!
Declare a desired Directory output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withEnvFileInput(name: String!,value: EnvFile!,description: String!): Env!
Create or update a binding of type EnvFile in the environment
name: String!The name of the binding
value: EnvFile!The EnvFile value to assign to the binding
description: String!The purpose of the input
withEnvFileOutput(name: String!, description: String!): Env!
Declare a desired EnvFile output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withEnvInput(name: String!,value: Env!,description: String!): Env!
Create or update a binding of type Env in the environment
name: String!The name of the binding
value: Env!The Env value to assign to the binding
description: String!The purpose of the input
withEnvOutput(name: String!, description: String!): Env!
Declare a desired Env output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withFileInput(name: String!,value: File!,description: String!): Env!
Create or update a binding of type File in the environment
name: String!The name of the binding
value: File!The File value to assign to the binding
description: String!The purpose of the input
withFileOutput(name: String!, description: String!): Env!
Declare a desired File output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withGeneratorGroupInput(name: String!,value: GeneratorGroup!,description: String!): Env!
Create or update a binding of type GeneratorGroup in the environment
name: String!The name of the binding
value: GeneratorGroup!The GeneratorGroup value to assign to the binding
description: String!The purpose of the input
withGeneratorGroupOutput(name: String!, description: String!): Env!
Declare a desired GeneratorGroup output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withGeneratorInput(name: String!,value: Generator!,description: String!): Env!
Create or update a binding of type Generator in the environment
name: String!The name of the binding
value: Generator!The Generator value to assign to the binding
description: String!The purpose of the input
withGeneratorOutput(name: String!, description: String!): Env!
Declare a desired Generator output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withGitRefInput(name: String!,value: GitRef!,description: String!): Env!
Create or update a binding of type GitRef in the environment
name: String!The name of the binding
value: GitRef!The GitRef value to assign to the binding
description: String!The purpose of the input
withGitRefOutput(name: String!, description: String!): Env!
Declare a desired GitRef output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withGitRepositoryInput(name: String!,value: GitRepository!,description: String!): Env!
Create or update a binding of type GitRepository in the environment
name: String!The name of the binding
value: GitRepository!The GitRepository value to assign to the binding
description: String!The purpose of the input
withGitRepositoryOutput(name: String!, description: String!): Env!
Declare a desired GitRepository output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withHTTPStateInput(name: String!,value: HTTPState!,description: String!): Env!
Create or update a binding of type HTTPState in the environment
name: String!The name of the binding
value: HTTPState!The HTTPState value to assign to the binding
description: String!The purpose of the input
withHTTPStateOutput(name: String!, description: String!): Env!
Declare a desired HTTPState output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withJSONValueInput(name: String!,value: JSONValue!,description: String!): Env!
Create or update a binding of type JSONValue in the environment
name: String!The name of the binding
value: JSONValue!The JSONValue value to assign to the binding
description: String!The purpose of the input
withJSONValueOutput(name: String!, description: String!): Env!
Declare a desired JSONValue output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withMainModule(module: Module!): Env!
Sets the main module for this environment (the project being worked on)
Contextual path arguments will be populated using the environment's workspace.
module: Module!
withModule(module: Module!): Env!Deprecated
Installs a module into the environment, exposing its functions to the model
Contextual path arguments will be populated using the environment's workspace.
Deprecated: Use withMainModule instead
module: Module!
withModuleConfigClientInput(name: String!,value: ModuleConfigClient!,description: String!): Env!
Create or update a binding of type ModuleConfigClient in the environment
name: String!The name of the binding
value: ModuleConfigClient!The ModuleConfigClient value to assign to the binding
description: String!The purpose of the input
withModuleConfigClientOutput(name: String!, description: String!): Env!
Declare a desired ModuleConfigClient output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withModuleInput(name: String!,value: Module!,description: String!): Env!
Create or update a binding of type Module in the environment
name: String!The name of the binding
value: Module!The Module value to assign to the binding
description: String!The purpose of the input
withModuleOutput(name: String!, description: String!): Env!
Declare a desired Module output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withModuleSourceInput(name: String!,value: ModuleSource!,description: String!): Env!
Create or update a binding of type ModuleSource in the environment
name: String!The name of the binding
value: ModuleSource!The ModuleSource value to assign to the binding
description: String!The purpose of the input
withModuleSourceOutput(name: String!, description: String!): Env!
Declare a desired ModuleSource output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withoutOutputs: Env!
Returns a new environment without any outputs
withSearchResultInput(name: String!,value: SearchResult!,description: String!): Env!
Create or update a binding of type SearchResult in the environment
name: String!The name of the binding
value: SearchResult!The SearchResult value to assign to the binding
description: String!The purpose of the input
withSearchResultOutput(name: String!, description: String!): Env!
Declare a desired SearchResult output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withSearchSubmatchInput(name: String!,value: SearchSubmatch!,description: String!): Env!
Create or update a binding of type SearchSubmatch in the environment
name: String!The name of the binding
value: SearchSubmatch!The SearchSubmatch value to assign to the binding
description: String!The purpose of the input
withSearchSubmatchOutput(name: String!, description: String!): Env!
Declare a desired SearchSubmatch output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withSecretInput(name: String!,value: Secret!,description: String!): Env!
Create or update a binding of type Secret in the environment
name: String!The name of the binding
value: Secret!The Secret value to assign to the binding
description: String!The purpose of the input
withSecretOutput(name: String!, description: String!): Env!
Declare a desired Secret output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withServiceInput(name: String!,value: Service!,description: String!): Env!
Create or update a binding of type Service in the environment
name: String!The name of the binding
value: Service!The Service value to assign to the binding
description: String!The purpose of the input
withServiceOutput(name: String!, description: String!): Env!
Declare a desired Service output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withSocketInput(name: String!,value: Socket!,description: String!): Env!
Create or update a binding of type Socket in the environment
name: String!The name of the binding
value: Socket!The Socket value to assign to the binding
description: String!The purpose of the input
withSocketOutput(name: String!, description: String!): Env!
Declare a desired Socket output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withStatInput(name: String!,value: Stat!,description: String!): Env!
Create or update a binding of type Stat in the environment
name: String!The name of the binding
value: Stat!The Stat value to assign to the binding
description: String!The purpose of the input
withStatOutput(name: String!, description: String!): Env!
Declare a desired Stat output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withStringInput(name: String!,value: String!,description: String!): Env!
Provides a string input binding to the environment
name: String!The name of the binding
value: String!The string value to assign to the binding
description: String!The description of the input
withStringOutput(name: String!, description: String!): Env!
Declares a desired string output binding
name: String!The name of the binding
description: String!The description of the output
withUpGroupInput(name: String!,value: UpGroup!,description: String!): Env!
Create or update a binding of type UpGroup in the environment
name: String!The name of the binding
value: UpGroup!The UpGroup value to assign to the binding
description: String!The purpose of the input
withUpGroupOutput(name: String!, description: String!): Env!
Declare a desired UpGroup output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withUpInput(name: String!,value: Up!,description: String!): Env!
Create or update a binding of type Up in the environment
name: String!The name of the binding
value: Up!The Up value to assign to the binding
description: String!The purpose of the input
withUpOutput(name: String!, description: String!): Env!
Declare a desired Up output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withWorkspace(workspace: Directory!): Env!
Returns a new environment with the provided workspace
workspace: Directory!The directory to set as the host filesystem
withWorkspaceGitInput(name: String!,value: WorkspaceGit!,description: String!): Env!
Create or update a binding of type WorkspaceGit in the environment
name: String!The name of the binding
value: WorkspaceGit!The WorkspaceGit value to assign to the binding
description: String!The purpose of the input
withWorkspaceGitOutput(name: String!, description: String!): Env!
Declare a desired WorkspaceGit output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withWorkspaceInput(name: String!,value: Workspace!,description: String!): Env!
Create or update a binding of type Workspace in the environment
name: String!The name of the binding
value: Workspace!The Workspace value to assign to the binding
description: String!The purpose of the input
withWorkspaceMigrationInput(name: String!,value: WorkspaceMigration!,description: String!): Env!
Create or update a binding of type WorkspaceMigration in the environment
name: String!The name of the binding
value: WorkspaceMigration!The WorkspaceMigration value to assign to the binding
description: String!The purpose of the input
withWorkspaceMigrationOutput(name: String!, description: String!): Env!
Declare a desired WorkspaceMigration output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withWorkspaceMigrationStepInput(name: String!,value: WorkspaceMigrationStep!,description: String!): Env!
Create or update a binding of type WorkspaceMigrationStep in the environment
name: String!The name of the binding
value: WorkspaceMigrationStep!The WorkspaceMigrationStep value to assign to the binding
description: String!The purpose of the input
withWorkspaceMigrationStepOutput(name: String!, description: String!): Env!
Declare a desired WorkspaceMigrationStep output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withWorkspaceModuleInput(name: String!,value: WorkspaceModule!,description: String!): Env!
Create or update a binding of type WorkspaceModule in the environment
name: String!The name of the binding
value: WorkspaceModule!The WorkspaceModule value to assign to the binding
description: String!The purpose of the input
withWorkspaceModuleOutput(name: String!, description: String!): Env!
Declare a desired WorkspaceModule output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withWorkspaceModuleSettingInput(name: String!,value: WorkspaceModuleSetting!,description: String!): Env!
Create or update a binding of type WorkspaceModuleSetting in the environment
name: String!The name of the binding
value: WorkspaceModuleSetting!The WorkspaceModuleSetting value to assign to the binding
description: String!The purpose of the input
withWorkspaceModuleSettingOutput(name: String!, description: String!): Env!
Declare a desired WorkspaceModuleSetting output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding
withWorkspaceOutput(name: String!, description: String!): Env!
Declare a desired Workspace output to be assigned in the environment
name: String!The name of the binding
description: String!A description of the desired value of the binding