Skip to content

INSTALLATION.md

Latest commit

 

History

History
81 lines (55 loc) · 2.84 KB

INSTALLATION.md

File metadata and controls

81 lines (55 loc) · 2.84 KB
Raw

Installation

Requirements

  • Python 3.11+
  • Git
  • the coding-agent/provider executables you choose to configure

No interactive runtime host is required for core operation.

Development install

python -m venv .venv
. .venv/bin/activate
python -m pip install -e '.[dev]'
agent-workflow --version
agent-workflow doctor

Wheel install

python -m build
python -m pip install dist/agent_workflow-*.whl

The shared contracts source is hosted on GitHub and installed directly by the project dependency:

python -m pip install git+https://github.com/ngallodev-software/agent-workflow-spec-contracts.git

The source installer links skills into Codex by default. Opt into other harness roots explicitly, for example bash scripts/install-source.sh --harnesses codex,claude,generic; omitted legacy harnesses have only Agent-Workflow-owned links removed.

Optional feature groups are declared in pyproject.toml for evaluation, statistics, completion generation, benchmark visuals, and MCP. The default source installer does not install or register MCP. To opt in explicitly from a checkout or release bundle:

bash scripts/install-mcp.sh

Use --no-register to install the MCP adapter without changing Codex or Claude configuration. Use --unregister to remove only Agent-Workflow-owned MCP entries.

Windows 11

Install a built wheel from PowerShell:

.\install.ps1 -Python python -Wheel .\dist\agent_workflow-*.whl

This installs the Python launcher and creates %APPDATA%\agent-workflow\config.toml without registering MCP, skills, or hooks. That avoids mixing MCP and CLI benchmark integrations; choose the benchmark cohort explicitly with --codebase-memory-mode.

Configuration

Configuration is normally read from the XDG configuration path. The core config defines executor, Git, policy, security, plugin, workflow, and evidence behavior. It does not select an interactive terminal backend.

The shipped schemas/config.schema.json is the public JSON Schema for the configuration document and is installed with the other schemas. Runtime TOML parsing and policy validation remain owned by src/agent_workflow/config.py; the schema is a contract/reference check, not a second configuration validator.

Tagged bootstrap install

For a published release, pin the release explicitly. For version 0.10.0:

curl -fsSL https://github.com/ngallodev-software/agent-workflow/releases/download/v0.10.0/install.sh | \
  sh -s -- --version v0.10.0

The version is intentional: the 0.9 line builds on the breaking Agent Run/headless-core rewrite and does not carry terminal-host compatibility.

Repository-only CI assets

Jenkins and local server-job definitions are excluded from installed wheels and platform runtime bundles. They remain source-repository maintenance assets only.