Skip to content

Harzva/AgentWorkOS

Repository files navigation

AgentWorkOS logo

AgentWorkOS

A package manager for portable AI agent workspaces.

Declare Skills, agents, rules, prompts, term maps, MCP configs, hooks, and repo checkouts once. Sync them into Codex, Claude Code, and future agent runtimes with explicit target adapters.

Docs Site · Stack Spec · Package Spec · Runtime Targets · Schemas · Example Stack

CLI Status Python Docs License

AgentWorkOS architecture

Why This Exists

AI agent workspaces are becoming real development environments, but their context is still scattered across local Skills, role cards, AGENTS.md, CLAUDE.md, prompts, MCP settings, hooks, and useful repositories.

AgentWorkOS turns that loose context into a package-managed stack:

Need AgentWorkOS answer
Move to a new machine agentworkos.toml + agentworkos.lock.json describe what to install
Compare local runtime drift aw scan inventories Codex, Claude Code, and repo state
Install safely aw sync is dry-run by default; writes require --apply
Explain local shorthand aw explain 三端同步 expands team-specific terms from TERMS.md
Support multiple agents runtime-specific targets map one package to Codex, Claude Code, or future adapters

Supported Runtimes

Runtime Status Skills Agents / Subagents Rules / Memory Commands / Prompts Terms MCP
Codex ✅ supported adapter adapter
Claude Code ✅ supported adapter
Cursor 🚧 planned 🚧 🚧 🚧 🚧 🚧 🚧
Windsurf 🚧 planned 🚧 🚧 🚧 🚧 🚧 🚧
Gemini CLI 🚧 planned 🚧 🚧 🚧 🚧 🚧 🚧
OpenCode 🚧 planned 🚧 🚧 🚧 🚧 🚧 🚧

Only Codex and Claude Code are marked supported in the first adapter set. See Supported Runtimes for the full matrix.

30-Second Start

python -m pip install -e .
aw install github:Harzva/AgentWorkOS --target all
aw scan --workspace .
aw doctor

install and sync are dry-run by default. Apply only after the plan looks right:

aw install github:Harzva/AgentWorkOS --target all --apply

awos remains available as a backward-compatible alias, but new docs and scripts use aw.

GitHub Knowledge Model

AgentWorkOS treats GitHub as the knowledge source for your agent workspace:

Layer AgentWorkOS file or command Similar idea
Stack repo AgentWorkOS-Stack on GitHub project environment repo
Manifest agentworkos.toml requirements.txt, environment.yml
Lockfile agentworkos.lock.json uv.lock, flake.lock
Install aw install github:OWNER/REPO pip install git+...
Runtime projection aw sync --target all installed environment

Recommended restore flow on a new machine:

aw install github:OWNER/AgentWorkOS-Stack --target all --apply
aw scan
aw doctor

Read the step-by-step tutorial in GitHub Knowledge Management or the GitHub Pages docs site.

Runtime Targets

Codex and Claude Code do not package context in exactly the same shape, so AgentWorkOS keeps package identity separate from runtime projection.

Package type Codex target Claude Code target
skill .codex/skills/<name>/SKILL.md ~/.claude/skills/<name>/SKILL.md when supported
agent .codex/agents/roles/<name>.md ~/.claude/agents/<name>.md or project .claude/agents/<name>.md
rule AGENTS.md or local agent rules CLAUDE.md memory files
prompt command or prompt adapter .claude/commands/<name>.md
terms .codex/agents/TERMS.md CLAUDE.md section or ~/.claude/TERMS.md adapter

Example target declaration:

[[packages.targets]]
runtime = "codex"
install_to = "skills/readme-design"

[[packages.targets]]
runtime = "claude-code"
install_to = "skills/readme-design"
adapter = "skill-to-claude-skill"

See Agent Runtime Targets for the adapter matrix and official runtime references.

Core Concepts

Concept File Similar idea
Stack agentworkos.toml environment.yml, requirements.txt, pyproject.toml
Lockfile agentworkos.lock.json uv.lock, flake.lock
Package agentpkg.toml or [[packages]] package metadata
Target [[packages.targets]] runtime adapter output
Runtime .codex, .claude, local repos installed environment
Doctor aw doctor environment health check
Term map TERMS.md shorthand expansion table

Commands

Command Purpose
aw init Create a sample stack manifest and term map
aw scan Inventory local Skills, agents, terms, Claude Code assets, and repos
aw lock Generate agentworkos.lock.json from the manifest
aw sync Dry-run package installation into runtime paths
aw sync --target claude-code Project packages into the Claude Code runtime
aw sync --apply Apply local package sync
aw install github:OWNER/REPO Install a Stack Repo or Package Repo from GitHub
aw doctor Check manifest health and common drift
aw explain 三端同步 Expand a shorthand term from TERMS.md

Package Types

Type Meaning
skill A SKILL.md capability package plus supporting files
agent A role card, local agent definition, or subagent source
rule AGENTS.md, CLAUDE.md, or hard operating rule
terms Versioned shorthand glossary
prompt Reusable prompt or slash-command source
sop Standard operating procedure
hook Lifecycle check or future automation contract
mcp MCP/tool config description
repo Useful source repository checkout

Repository Layout

AgentWorkOS/
├─ src/agentworkos/       # aw CLI implementation
├─ schemas/               # JSON schemas for stack, lock, and packages
├─ docs/specs/            # human-readable specs
├─ docs/assets/tutorial/  # README and Pages tutorial images
├─ docs/agent-targets.md  # Codex / Claude Code adapter model
├─ examples/              # sample AgentWorkOS stack
├─ skills/                # installable AgentWorkOS skills
├─ scripts/               # bootstrap helpers
└─ tests/                 # CLI and parser tests

Design Inspirations

AgentWorkOS borrows proven package-management ideas rather than inventing hidden state:

  • uv: one fast CLI for projects, locks, sync, tools, and Python environments.
  • conda: environment files for complete machine-portable setups.
  • pip: plain dependency declarations that are easy to review.
  • Nix flakes: declared inputs plus lockfiles for reproducibility.

See docs/inspirations.md for source links and adoption notes.

Roadmap

Stage Target
v0.1 Scan, init, lock, doctor, dry-run sync, explain terms
v0.2 Runtime target adapters for Codex and Claude Code
v0.3 Remote git package cache and locked install
v0.4 agentpkg.toml validation and package publish checklist
v0.5 Three-end sync verifier for runtime, source repo, and remote
v1.0 Stable AgentWorkOS Package Spec

Safety

  • No destructive sync by default.
  • Runtime writes require --apply.
  • No secret collection.
  • No raw private chat log packaging.
  • Local paths belong in agentworkos.local.toml, not public stack manifests.
  • Public packages should include specs, schemas, docs, tests, and release proof.

License

MIT

About

Package-managed operating layer for AI agent workspaces: scan, lock, sync, doctor, and install agent context.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors