Instalación

Pon el binario de orch en el PATH en Windows, macOS o Linux, y confirma la versión y el machine home.

Objetivo#

Un binario en el PATH y un machine home donde orch guarda los archivos que son tuyos y no de un workspace en particular.

Pasos#

0. Consigue el binario#

orch se entrega como un solo ejecutable precompilado. Todavía no hay releases con tag ni página de descarga publicadas: hasta que las haya, el binario te lo entrega el equipo de Orchemax junto con tu cuenta. En Windows el archivo es orch.exe; en Linux y macOS es orch sin extensión.

Si en vez de un binario recibiste una copia del código fuente, compílalo tú mismo (el módulo fija go 1.26.3 — instala esa versión o una más nueva):

# Windows (PowerShell), desde la raíz de la copia
cd client
go build -o orch.exe ./cmd/orch

# Linux / macOS, desde la raíz de la copia
cd client
go build -o orch ./cmd/orch

Mueve ese archivo a la carpeta del paso 1 y agrega esa carpeta al PATH — el resto de esta página es igual en ambos casos.

1. Pon el binario en su propia carpeta#

orch es un único ejecutable. Colócalo donde prefieras y agrega esa carpeta al PATH de tu usuario. Ahí nunca se escribe nada más: la carpeta queda vacía de archivos de orch, como dice orch --help: "that folder stays empty of Orche files — PATH only".

Plataforma Carpeta sugerida Cómo agregarla al PATH
Windows %LOCALAPPDATA%\Programs\orch\ Variables de entorno del usuario → Path → nueva entrada. orch setup se ofrece a hacerlo por ti.
macOS ~/bin o /usr/local/bin Agrega export PATH="$HOME/bin:$PATH" al perfil de tu shell.
Linux ~/.local/bin o /usr/local/bin Igual; ~/.local/bin ya está en el PATH en casi todas las distribuciones.

En macOS y Linux el archivo necesita el bit de ejecución: chmod +x orch.

2. Confirma que el binario responde#

orch version

orch version imprime la cadena de versión y nada más. Si el shell dice que el comando no existe, la carpeta del paso 1 todavía no está en el PATH: abre una terminal nueva o revisa la entrada.

3. Ubica tu machine home#

orch home

orch home imprime dónde viven los archivos de identidad frente a dónde vive el runtime de este workspace:

Machine-home (identity):
  <machine home>
  files: account.json, session.bin, device.token, license.cache.json
Workspace runtime:
  <workspace>/.orch
  files: orch.db, agents/, gateway keys, setup.json, machine.bind.json
Bound: (none yet - login/link writes machine.bind.json)

El machine home se resuelve en este orden:

  1. ORCH_HOME, cuando está definida.
  2. En Windows, %LOCALAPPDATA%\Orchemax.
  3. Si no, $XDG_CONFIG_HOME/orchemax, con ~/.config/orchemax como respaldo.

Las llaves de API de los proveedores también viven ahí, en keys.env: una sola bóveda para todos los workspaces de la máquina. La carpeta .orch/ del workspace guarda solo la base de datos de runtime y los worktrees de ese workspace.

Cómo verificar#

  • orch version imprime una versión.
  • orch home imprime ambos bloques y no da error.
  • orch a secas imprime la ayuda, incluido un pie Detected agents con los CLI de agentes encontrados en tu PATH.

Relacionado#