README.md

June 4, 2026 · View on GitHub

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 promo card

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:

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

Supported Runtimes

RuntimeStatusSkillsAgents / SubagentsRules / MemoryCommands / PromptsTermsMCP
Codex✅ supportedadapteradapter
Claude Code✅ supportedadapter
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.

For this repository itself, use the bundled installer:

pwsh -ExecutionPolicy Bypass -File .\install.ps1 -Profile codex -Target codex
pwsh -ExecutionPolicy Bypass -File .\install.ps1 -Profile codex -Target codex -Apply

macOS/Linux:

./install.sh --profile codex --target codex
./install.sh --profile codex --target codex --apply

GitHub Knowledge Model

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

LayerAgentWorkOS file or commandSimilar idea
Stack repoAgentWorkOS-Stack on GitHubproject environment repo
Manifestagentworkos.tomlrequirements.txt, environment.yml
Lockfileagentworkos.lock.jsonuv.lock, flake.lock
Installaw install github:OWNER/REPOpip install git+...
Runtime projectionaw sync --target allinstalled environment

Recommended restore flow on a new machine:

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

Profiles let one stack expose multiple install sizes:

ProfilePurpose
baseCore AgentWorkOS terms and inventory skill
codexCodex runtime profile with core authoring skills such as roadmp-writer
just-ddlJust-DDL operator profile with managed repo checkout references
fullEvery package and managed repo declared by the stack

Examples:

aw doctor --manifest agentworkos.toml --profile just-ddl
aw sync --manifest agentworkos.toml --target codex --profile codex --apply

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 typeCodex targetClaude 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
ruleAGENTS.md or local agent rulesCLAUDE.md memory files
promptcommand or prompt adapter.claude/commands/<name>.md
terms.codex/agents/TERMS.mdCLAUDE.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

ConceptFileSimilar idea
Stackagentworkos.tomlenvironment.yml, requirements.txt, pyproject.toml
Lockfileagentworkos.lock.jsonuv.lock, flake.lock
Packageagentpkg.toml or [[packages]]package metadata
Target[[packages.targets]]runtime adapter output
Runtime.codex, .claude, local reposinstalled environment
Doctoraw doctorenvironment health check
Term mapTERMS.mdshorthand expansion table

Commands

CommandPurpose
aw initCreate a sample stack manifest and term map
aw scanInventory local Skills, agents, terms, Claude Code assets, and repos
aw lockGenerate agentworkos.lock.json from the manifest
aw syncDry-run package installation into runtime paths
aw sync --target claude-codeProject packages into the Claude Code runtime
aw sync --applyApply local package sync
aw install github:OWNER/REPOInstall a Stack Repo or Package Repo from GitHub
aw doctorCheck manifest health and common drift
aw explain 三端同步Expand a shorthand term from TERMS.md

What aw Commands Update

aw is the short CLI command for the AgentWorkOS package manager. awos remains available as a backward-compatible alias, but new docs and scripts should use aw.

CommandWhat it doesWrites runtime files?
aw lockUpdates the current repo's agentworkos.lock.json from agentworkos.tomlNo
aw doctorChecks manifest health, profile resolution, package paths, and target declarationsNo
aw sync --target codexPreviews which packages would be projected into the Codex runtimeNo, dry-run only
aw sync --target codex --applyCopies the selected skills, agents, rules, and terms into ~/.codexYes
aw sync --target claude-code --applyCopies the selected packages into ~/.claude or Claude Code project targetsYes
aw sync --target all --applyApplies the selected stack to every supported runtime target declared by the manifestYes
aw install github:OWNER/REPOClones a GitHub stack/package into a temporary install flow and previews runtime projectionNo, dry-run only
aw install github:OWNER/REPO --applyInstalls from GitHub and writes the selected runtime targetsYes

In practical terms:

agentworkos.toml
-> agentworkos.lock.json
-> aw sync / aw install
-> ~/.codex and/or ~/.claude runtime copies

So aw sync --apply does not update GitHub or npm. It updates the local agent runtime library selected by --target, such as .codex for Codex or .claude for Claude Code.

Package Types

TypeMeaning
skillA SKILL.md capability package plus supporting files
agentA role card, local agent definition, or subagent source
ruleAGENTS.md, CLAUDE.md, or hard operating rule
termsVersioned shorthand glossary
promptReusable prompt or slash-command source
sopStandard operating procedure
hookLifecycle check or future automation contract
mcpMCP/tool config description
repoUseful 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

StageTarget
v0.1Scan, init, lock, doctor, dry-run sync, explain terms
v0.2Runtime target adapters for Codex and Claude Code
v0.3Remote git package cache and locked install
v0.4agentpkg.toml validation and package publish checklist
v0.5Three-end sync verifier for runtime, source repo, and remote
v1.0Stable 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