ZacharyZhang-NY/AgentCompany
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity
Files
c71d033b0c223feabfe74c8c4234bdd10925df7b
AgentCompany/README.md
T
ZacharyZhang-NY 34ca5b77f1 docs(readme): cut marketing fluff; one fact per sentence 
Removing what a reader doesn't need:

- Subtitle shrunk from three sentences to one. "Run an AI company from
  your desktop." The two follow-up sentences ("Give it a mission.
  Watch agents hire, delegate, and deliver.") were restating the same
  thing twice.
- "Built with quiet authority. Ship your AI company." closing tagline
  deleted. AI-flavored vapor.
- Feature openers trimmed. Each feature is now [bold title] + [one
  sentence]. The previous paragraphs qualified, reassured, and
  explained their own engineering trade-offs ("context travels with
  the work instead of being re-rendered from scratch every run"). A
  reader skimming the README doesn't need the trade-off; the architecture
  section has it.
- "No plaintext, no ~/.pi/agent/auth.json, no scattered env files"
  rhetorical triad replaced with "Credentials are SecretVault-encrypted
  in SQLite." One fact, stated once.
- "Agents are at work before your coffee" deleted. Cute-cringe.
- "the company respects the chain of command" deleted. Hollow.
- "What is AgentCompany?" section compressed from three paragraphs to
  two sentences.
- Image alt text shortened where it was describing the screenshot to
  the screenshot ("AgentCompany Dashboard — active agents, tasks, and
  company metrics" → "AgentCompany dashboard"). Alt text is for screen
  readers landing on the page, not for search engine padding.
- Top-nav link list trimmed from 4 entries to 2 (Download, Website).
  The in-page anchors were noise.

Facts preserved verbatim: 26 providers with correct per-group counts
(5/18/3), the two execution modes with their approval gate names,
architecture tree, tech stack, first-run steps, build commands.
Nothing factual removed.

Line count: 186 → ~170, but the bigger win is prose density — every
paragraph now says exactly one thing.
2026-04-17 21:59:34 -04:00

191 lines
6.0 KiB
Markdown
Raw Blame History

<p align="center">
<img src="assets/icon.svg" width="80" height="80" alt="AgentCompany logo" />
</p>
<h1 align="center">AgentCompany</h1>
<p align="center"><strong>Run an AI company from your desktop.</strong></p>
<p align="center">
<a href="https://github.com/ZacharyZhang-NY/AgentCompany/releases"><img alt="Latest Release" src="https://img.shields.io/github/v/release/ZacharyZhang-NY/AgentCompany?style=flat-square&color=4a5d7a" /></a>
<a href="https://github.com/ZacharyZhang-NY/AgentCompany/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/github/license/ZacharyZhang-NY/AgentCompany?style=flat-square&color=4a5d7a" /></a>
<img alt="Platform" src="https://img.shields.io/badge/platform-macOS%20%7C%20Windows%20%7C%20Linux-4a5d7a?style=flat-square" />
<img alt="Electron" src="https://img.shields.io/badge/electron-39.8.0-4a5d7a?style=flat-square" />
</p>
<p align="center">
<a href="https://github.com/ZacharyZhang-NY/AgentCompany/releases">Download</a>&nbsp;&nbsp;|&nbsp;&nbsp;<a href="https://agentcompany.pages.dev">Website</a>
</p>
---
<p align="center">
<img src="screenshots/Dashboard.jpeg" width="800" alt="AgentCompany dashboard" />
</p>
## What it does
Type a company name and a goal. A CEO agent boots, hires specialists, forms departments, and runs the business. You approve or steer from the desktop.
Local, SQLite-backed, no external services. Inspired by [Paperclip](https://github.com/paperclipai/paperclip).
---
## 26 providers, no CLI
The runtime links [pi-mono](https://github.com/mariozechner/pi) directly. No `claude` / `codex` / `gemini` binaries on your PATH.
**OAuth (5):** Claude Pro/Max · ChatGPT Plus/Pro (Codex) · GitHub Copilot · Gemini CLI · Antigravity
**API key (18):** Anthropic · OpenAI · Google · Mistral · Groq · Cerebras · xAI · OpenRouter · Vercel AI Gateway · ZAI · OpenCode · OpenCode Go · Hugging Face · Kimi · MiniMax · MiniMax CN · Fireworks · Fireworks Firepass
**Cloud (3):** Azure OpenAI · AWS Bedrock · Google Vertex AI
Credentials are SecretVault-encrypted in SQLite.
---
## Two execution modes
- **AI CEO** — autonomous. Hiring, tasks, deliverables run without you.
- **AI Co-Founder** — pauses at `hire_agent` / `document_review` / `plan_review` / `strategy_review` for your decision.
Switch at Settings → Execution mode.
---
## Features
### Self-organizing teams
CEO builds the org chart from one goal.
<p align="center">
<img src="screenshots/Auto-OrgChart-Team.jpeg" width="700" alt="Org chart" />
</p>
### Agent messaging
Threads and DMs between agents. Messages land in each recipient's transcript as pi `AgentMessage` turns.
<p align="center">
<img src="screenshots/AI-Internal-Realtime-Message.jpeg" width="700" alt="Agent messaging" />
</p>
### Tasks
Goals break into tasks. Agents pick them up, report progress, escalate blockers.
<p align="center">
<img src="screenshots/Auto-Task.jpeg" width="700" alt="Task queue" />
</p>
### Approvals
Hiring, deliverables, plan/scope/strategy reviews, budget overrides, production deploys pause for the board.
<p align="center">
<img src="screenshots/Approval-by-Human.jpeg" width="700" alt="Approvals" />
</p>
### Documents
Plans, strategies, and specs in a shared center, linked to the tasks that produced them.
<p align="center">
<img src="screenshots/Document-Center.jpeg" width="700" alt="Document center" />
</p>
### Launch in a minute
Name, mission, goal, provider, mode.
<p align="center">
<img src="screenshots/Onboarding.jpeg" width="700" alt="Onboarding" />
</p>
---
## Quick Start
[Download the latest release](https://github.com/ZacharyZhang-NY/AgentCompany/releases) — macOS (Apple Silicon & Intel), Windows, Linux.
### Build from source
```sh
# Node.js 22+, pnpm 10+
pnpm install
pnpm dev
```
### First run
1. Onboarding probes your shell PATH for `node` (agents call the local HTTP API via `node -e`).
2. Settings → Providers. Sign in or drop a key.
3. Create a company: name, mission, goal, mode, workspace.
---
## Verification
```sh
pnpm typecheck
pnpm lint
pnpm test:unit
pnpm test:integration
pnpm test:e2e
pnpm build:verify
```
## Packaging
```sh
pnpm build # Package for current platform → /build/release
pnpm build:dir # Unpackaged directory
pnpm build:current # Current host platform
pnpm release:local # Signed release pipeline — see docs/release/local-r2.md
```
Targets: macOS `.dmg`, Windows `.exe` (NSIS), Linux `.AppImage`. Built with `electron-builder`. Local builds use ad-hoc signing (`CSC_IDENTITY_AUTO_DISCOVERY=false`). Defaults to `--publish never`.
---
## Architecture
```
src/
main/
agent-runtime/ RuntimeBridge, SqliteSessionStore, CostWriter
credentials/ CredentialStore, Resolver, OAuthLoginService
api-server/ Agent HTTP API
orchestration/ Scheduler, run dispatch
prompt-builder/ System prompt assembly
thread-integration/ Thread runtime event routing
worker/ utilityProcess worker — direct new Agent(...)
database/ SQLite schema + migrations
preload/ Typed DesktopApi via contextBridge
renderer/ React 19 UI
shared/ Zod schemas shared across processes
```
- SQLite local; no external services.
- `contextIsolation: true`, `nodeIntegration: false`, Zod-validated IPC.
- Worker constructs `new Agent({...})` from `@mariozechner/pi-agent-core` directly.
- Sessions persist as `session_entries`; auto-compact via `shouldCompact` / `compact`.
- Thread runtime (`conversation_threads` / `conversation_events` / `thread_wait_states`) sits above pi's `AgentMessage` stream.
---
## Tech Stack
| Layer | Tech |
|-------|------|
| Framework | Electron 39.8.0 |
| Language | TypeScript 5.9 |
| UI | React 19, Tailwind CSS 4, Framer Motion, Zustand |
| Build | electron-vite, Vite 7, electron-builder |
| Database | SQLite via `node:sqlite` (WAL) |
| Validation | Zod 4 |
| Agent runtime | `@mariozechner/pi-ai`, `@mariozechner/pi-agent-core`, `@mariozechner/pi-coding-agent` |
| Testing | Vitest, Playwright |
---
## License
[MIT](LICENSE)
Reference in new issue View Git Blame Copy Permalink