egutierrez
5f4f1f7508
Añade campos params y output al frontmatter YAML de las 506 funciones del registry. Cada parámetro tiene descripción semántica (qué representa, unidades, rango típico) y cada función describe qué produce su output. Permite a agentes razonar sobre cadenas de composición (ej: prices → log_return → sharpe_ratio) sin leer código.
42 lines
1.3 KiB
Markdown
42 lines
1.3 KiB
Markdown
---
|
|
name: docker_compose_up
|
|
kind: function
|
|
lang: go
|
|
domain: infra
|
|
version: "1.0.0"
|
|
purity: impure
|
|
signature: "func DockerComposeUp(composeFile string, detach bool) (string, error)"
|
|
description: "Levanta un stack docker-compose desde el archivo dado. Si detach es true ejecuta en background (-d). Retorna el stdout del comando."
|
|
tags: [docker, compose, up, infra]
|
|
uses_functions: []
|
|
uses_types: []
|
|
returns: []
|
|
returns_optional: false
|
|
error_type: "error_go_core"
|
|
imports: [fmt, os/exec, strings]
|
|
params:
|
|
- name: composeFile
|
|
desc: "ruta del archivo docker-compose.yml"
|
|
- name: detach
|
|
desc: "si true ejecuta en background sin bloquear"
|
|
output: "stdout combinado con stderr de la ejecucion de docker compose up"
|
|
tested: true
|
|
tests: ["detach true agrega flag -d al comando", "error si composeFile no existe"]
|
|
test_file_path: "functions/infra/docker_compose_up_test.go"
|
|
file_path: "functions/infra/docker_compose_up.go"
|
|
---
|
|
|
|
## Ejemplo
|
|
|
|
```go
|
|
out, err := DockerComposeUp("./docker-compose.yml", true)
|
|
if err != nil {
|
|
log.Fatal(err)
|
|
}
|
|
fmt.Println(out)
|
|
```
|
|
|
|
## Notas
|
|
|
|
Ejecuta `docker compose -f composeFile up [-d]`. Usa el subcomando `docker compose` (V2), no el binario standalone `docker-compose`. Retorna stdout + stderr combinados para facilitar el debugging. En modo no-detach bloquea hasta que el compose termine (util para stacks efimeros).
|