Skip to content

PackageGuide.md

Latest commit

 

History

History
66 lines (43 loc) · 2.04 KB

PackageGuide.md

File metadata and controls

66 lines (43 loc) · 2.04 KB

Symphony Package Guide

Release Bundles

GitHub Releases now build versioned bundles for:

  • Windows: win-x64, win-arm64
  • Linux: linux-x64, linux-arm64
  • macOS: osx-x64, osx-arm64

Each bundle is stamped from the release tag and attached back to the published GitHub Release.

The release workflow expects tags in one of these forms:

  • v1.2.3
  • v1.2.3-rc.1

First-Run Setup

After extracting a bundle, start the interactive installer:

  • Windows: .\setup-symphony.cmd
  • macOS/Linux: ./setup-symphony.sh

You can also run the binary directly:

  • Windows: .\Symphony.exe install
  • macOS/Linux: ./Symphony install

The text-mode installer prompts for:

  • GitHub token
  • GitHub owner
  • GitHub repository
  • Base branch
  • Instance folder
  • HTTP port

Before the installer auto-starts Symphony, it also checks the local Codex CLI:

  • codex --version must be present and at least the Symphony-validated version
  • if npm can be reached, the installed CLI must not be behind the latest @openai/codex version
  • Codex authentication must succeed via codex login status
  • auth.json must exist under ~/.codex/ (or CODEX_HOME when set)

If one of those checks fails, the installer pauses and tells you what to fix before the first start. With --no-launch, installation still completes, but the installer prints the Codex prerequisites you need to fix before running the instance later.

It then creates an isolated instance with:

  • its own WORKFLOW.md
  • its own appsettings.json
  • a local .env containing GITHUB_TOKEN
  • a local SQLite database under ./data/
  • isolated git workspaces under ./workspaces/
  • instance-local run scripts

Each instance gets its own stable Orchestration:InstanceId and its own loopback URL such as http://127.0.0.1:43123/, so multiple instances can run on the same machine without sharing runtime state.

Re-running an Installed Instance

From the instance folder:

  • Windows: .\run-symphony.cmd
  • macOS/Linux: ./run-symphony.sh

You can also run Symphony version to confirm the packaged build version.