Installation Guide
Get AgentCraftworks running on your GitHub organization in six steps.
- 1
Install the GitHub App
Click Install on the GitHub Marketplace listing. Select your organization and choose All repositories or specific repositories you want to govern with AgentCraftworks.
- 2
Grant Permissions
The app requires the following GitHub permissions during installation:
pull_requests: write— to post governance status and handoff updates on pull requestsissues: write— to assign agent work items to issuescontents: read— to read CODEOWNERS and.agentcraftworks.ymlconfiguration filesmembers: read— to resolve organization membership for agent identity verification
- 3
Configure the Webhook
For the Team/Enterprise SaaS tier, the webhook is pre-configured to the AgentCraftworks SaaS endpoint — no action required.
For self-hosted deployments, update the webhook URL in your GitHub App settings to point to your deployment endpoint. The webhook secret is available in your AgentCraftworks dashboard.
- 4
Add
.agentcraftworks.ymlCreate
.agentcraftworks.ymlin your repository root. This file controls governance settings for your agents. Below is a minimal starting template:version: "1" governance: default_engagement_level: 3 # Peer Programmer environment_caps: staging: 4 production: 3 agents: - id: copilot identity: "@github-copilot[bot]" engagement_level: 3See the reference template for the full configuration schema.
- 5
Configure CODEOWNERS Routing
Add an
[AGENTS]section to yourCODEOWNERSfile to route agent work items to specific AI agents by path:[AGENTS] /src/ @github-copilot[bot] /infra/ @claude-code-agentAgentCraftworks reads this section to determine which agent is responsible for a given pull request based on the files changed.
- 6
Verify the Installation
Open a test pull request in your repository. Within a few seconds, you should see an AgentCraftworks check run appear on the PR — it will show the assigned agent and governance status.
Check the AgentCraftworks dashboard to confirm the webhook was received and the governance event was processed.
Need help?
If you run into issues during installation, we're here to help.
- Email support: support@agentcraftworks.com (Team & Enterprise tiers)
- Support page: agentcraftworks.com/support
- Community: GitHub Issues (all tiers)