whatisgithub

What is arc-agent?

ariel-frischer/arc-agent — explained in plain English

Analysis updated 2026-05-18

0GoAudience · developerComplexity · 3/5LicenseSetup · moderate

In one sentence

A Go CLI that uses AI to generate validated, staged system design documents, YAML artifacts, and Mermaid diagrams for a new software project.

Mindmap

mindmap
  root((arc-agent))
    What it does
      Generates design docs
      Validates YAML stages
      Renders diagrams
    Tech stack
      Go CLI
      Mermaid
      OpenCode
      Claude Code
    Use cases
      System design starting point
      Reviewable architecture docs
      Multi runner AI generation
    Audience
      Developers
      Architects
    Setup
      Shell install script
      macOS and Linux
      Needs AI runner or key

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Generate a structured design workspace with requirements, API shape, and diagrams for a new system.

USE CASE 2

Turn a one line prompt like 'design a URL shortener' into a reviewable DESIGN.md and diagram.

USE CASE 3

Validate and repair AI generated design artifacts against a schema instead of trusting raw output.

USE CASE 4

Choose between different AI runners such as Claude Code, Codex, or a direct API call for design generation.

What is it built with?

GoMermaidYAMLOpenCodeClaude Code CLI

How does it compare?

ariel-frischer/arc-agentaasheeshlikepanner/vasealexzielenski/controller-runtime
Stars00
LanguageGoGoGo
Last pushed2022-04-20
MaintenanceDormant
Setup difficultymoderatemoderatehard
Complexity3/54/54/5
Audiencedeveloperdeveloperdeveloper

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · moderate Time to first run · 30min

Needs an AI runner such as OpenCode, Codex, or Claude Code CLI, or an OpenCode Go API key for direct mode.

Use freely for any purpose, including commercial use, as long as you keep the copyright notice.

So what is it?

Arc-agent is a command line tool written in Go that uses AI to produce structured system design documents for software projects. System design is the process of planning how a software system's parts, such as databases, APIs, services, and data flows, fit together before or during development. This tool automates that planning by running a multi stage workflow where each stage, including requirements, entities, API shape, high level architecture, and optional deep dives, is handled by a separate AI call, checked against a schema, and repaired automatically if the output is invalid. The final output is a workspace folder containing validated YAML files for each stage, a DESIGN.md document in plain Markdown, and a Mermaid diagram file representing the architecture. Mermaid is a text based format that renders into visual flowcharts and diagrams. The tool can also export Excalidraw format diagrams and render SVG or PNG images from them. Arc-agent supports multiple AI runners. It can call OpenCode, Codex, or Claude Code as an agent inside an isolated workspace, or it can call the OpenCode Go API directly for faster, more predictable structured output. An auto mode picks the appropriate runner based on which API keys and tools are available locally. A person would use this when starting the design of a new system, such as a URL shortener, a messaging platform, or any multi component service, and wants a structured, reviewable starting point instead of a blank page. The staged workflow is inspired by a system design interview preparation guide that focuses on practical requirements, trade-offs, and clear communication. The tool installs through a shell script and runs on macOS and Linux, with Windows users expected to use WSL. It is released under the MIT license.

Copy-paste prompts

Prompt 1
Install arc-agent and run its first-time setup with arc-agent init.
Prompt 2
Use arc-agent to design a URL shortener like Bitly and explain the generated workspace files.
Prompt 3
Explain the difference between arc-agent's direct, agent, and auto runner modes.
Prompt 4
Show me how to validate and render an existing arc-agent design workspace.
Prompt 5
How do I resume an interrupted arc-agent workspace from a specific design stage?

Frequently asked questions

What is arc-agent?

A Go CLI that uses AI to generate validated, staged system design documents, YAML artifacts, and Mermaid diagrams for a new software project.

What language is arc-agent written in?

Mainly Go. The stack also includes Go, Mermaid, YAML.

What license does arc-agent use?

Use freely for any purpose, including commercial use, as long as you keep the copyright notice.

How hard is arc-agent to set up?

Setup difficulty is rated moderate, with roughly 30min to a first successful run.

Who is arc-agent for?

Mainly developer.

Open on GitHub → Ask about another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.