# AWF — AI Workflow Framework CLI

> Orchestrate AI agents through declarative YAML workflows with state machine execution.

- [Blog](https://awf-project.github.io/cli/blog/): News, release notes, and articles about AWF.
- [Page not found](https://awf-project.github.io/cli/404/): The page you're looking for doesn’t exist or has moved. Check the URL, use the navigation to browse sections, or return to the homepage.
- [Documentation](https://awf-project.github.io/cli/docs/): AWF CLI documentation — getting started, user guide, reference, and development.

## Blog

> News, release notes, and articles about AWF.

- [AWF Is Live](https://awf-project.github.io/cli/blog/awf-is-live/): AWF is officially released — a retrospective on what it took to get here, what's working, and what's coming next.
- [Introducing AWF](https://awf-project.github.io/cli/blog/introducing-awf/): AWF is an open-source CLI tool for orchestrating AI agents through declarative YAML workflows — built for developers who value determinism, efficiency, and engineering standards.

## Documentation

> AWF CLI documentation — getting started, user guide, reference, and development.

- [Getting Started](https://awf-project.github.io/cli/docs/getting-started/): Install AWF and create your first workflow.
- [User Guide](https://awf-project.github.io/cli/docs/user-guide/): Learn how to use AWF effectively.
- [Reference](https://awf-project.github.io/cli/docs/reference/): Technical reference documentation.
- [Development](https://awf-project.github.io/cli/docs/development/): Architecture, testing, and contribution guides.
- [Architecture Decision Records](https://awf-project.github.io/cli/docs/adr/): Documented architecture decisions for the AWF project.

### Getting Started

> Install AWF and create your first workflow.

- [Installation](https://awf-project.github.io/cli/docs/getting-started/installation/)
- [Quick Start](https://awf-project.github.io/cli/docs/getting-started/quick-start/)

### User Guide

> Learn how to use AWF effectively.

- [Agent Conversation Mode](https://awf-project.github.io/cli/docs/user-guide/agent-conversation-mode/)
- [Agent Steps Guide](https://awf-project.github.io/cli/docs/user-guide/agent-steps-guide/)
- [Audit Trail](https://awf-project.github.io/cli/docs/user-guide/audit-trail/)
- [CLI Commands](https://awf-project.github.io/cli/docs/user-guide/cli-commands/)
- [Interactive Input Collection](https://awf-project.github.io/cli/docs/user-guide/interactive-input-collection/)
- [Plugins](https://awf-project.github.io/cli/docs/user-guide/plugins/)
- [Project Configuration](https://awf-project.github.io/cli/docs/user-guide/project-configuration/)
- [Retry Configuration Guide](https://awf-project.github.io/cli/docs/user-guide/retry-configuration-guide/)
- [Workflow Examples](https://awf-project.github.io/cli/docs/user-guide/workflow-examples/)
- [Workflow Syntax Reference](https://awf-project.github.io/cli/docs/user-guide/workflow-syntax-reference/)
- [Workflow Templates](https://awf-project.github.io/cli/docs/user-guide/workflow-templates/)

### Reference

> Technical reference documentation.

- [Audit Trail Schema](https://awf-project.github.io/cli/docs/reference/audit-trail-schema/)
- [Error Codes Reference](https://awf-project.github.io/cli/docs/reference/error-codes-reference/)
- [Exit Codes](https://awf-project.github.io/cli/docs/reference/exit-codes/)
- [Input Validation](https://awf-project.github.io/cli/docs/reference/input-validation/)
- [Loop Reference](https://awf-project.github.io/cli/docs/reference/loop-reference/)
- [Package Documentation Guide](https://awf-project.github.io/cli/docs/reference/package-documentation-guide/)
- [Variable Interpolation](https://awf-project.github.io/cli/docs/reference/variable-interpolation/)

### Development

> Architecture, testing, and contribution guides.

- [Architecture](https://awf-project.github.io/cli/docs/development/architecture/)
- [Code Quality Tools](https://awf-project.github.io/cli/docs/development/code-quality-tools/)
- [Project Structure](https://awf-project.github.io/cli/docs/development/project-structure/)
- [Testing](https://awf-project.github.io/cli/docs/development/testing/)

### Architecture Decision Records

> Documented architecture decisions for the AWF project.


- [001: Hexagonal Architecture](https://awf-project.github.io/cli/docs/adr/001-hexagonal-architecture/)
- [002: Error Taxonomy with Exit Codes](https://awf-project.github.io/cli/docs/adr/002-error-taxonomy-with-exit-codes/)
- [003: YAML State Machine for Workflow Definition](https://awf-project.github.io/cli/docs/adr/003-yaml-state-machine-for-workflow-definition/)
- [004: Domain Operation Registry with Infrastructure Coexistence](https://awf-project.github.io/cli/docs/adr/004-domain-operation-registry-with-infrastructure-coexistence/)
- [005: Atomic File Writes for State Persistence](https://awf-project.github.io/cli/docs/adr/005-atomic-file-writes-for-state-persistence/)
- [006: XDG-Compliant Path Resolution](https://awf-project.github.io/cli/docs/adr/006-xdg-compliant-path-resolution/)
- [007: Agent Prompt XOR Constraint](https://awf-project.github.io/cli/docs/adr/007-agent-prompt-xor-constraint/)
- [008. OpenAI-Compatible Provider as HTTP Infrastructure Adapter](https://awf-project.github.io/cli/docs/adr/008.-openai-compatible-provider-as-http-infrastructure-adapter/)
- [009. Breaking Removal of Custom Provider at v0.4.0](https://awf-project.github.io/cli/docs/adr/009.-breaking-removal-of-custom-provider-at-v0.4.0/)
- [010. Paired JSONL Audit Trail with Atomic Append](https://awf-project.github.io/cli/docs/adr/010.-paired-jsonl-audit-trail-with-atomic-append/)
- [011. Application-Layer Secret Masking for Audit Events](https://awf-project.github.io/cli/docs/adr/011.-application-layer-secret-masking-for-audit-events/)
- [012. Runtime Shell Detection with $SHELL Environment Variable](https://awf-project.github.io/cli/docs/adr/012.-runtime-shell-detection-with-shell-environment-variable/)
- [013. Context-Aware Port Interfaces for User Input](https://awf-project.github.io/cli/docs/adr/013.-context-aware-port-interfaces-for-user-input/)
- [014: Shebang Execution for Script Files](https://awf-project.github.io/cli/docs/adr/014-shebang-execution-for-script-files/)