Weyaw

Weyaw is a local, artifact-backed workflow for agent work.

It exists for projects where agent work should be resumable, inspectable, and grounded in project files rather than scattered across chat history. Weyaw keeps the work loop small: define the intention, record the plan, execute with evidence, verify the result, and preserve useful knowledge for future agents.

Motivation

Agent sessions are good at local reasoning, but they are easy to interrupt and hard to audit after the fact. Weyaw treats agent work as a project artifact:

• Tasks have durable state and lifecycle.
• Plans, execution notes, verification, and summaries are written down.
• Project guidance stays close to the code.
• Work can be resumed without reconstructing context from memory.

The goal is not to replace human judgment or turn every change into process. The goal is to make non-trivial agent work easier to continue, review, and trust.

Scope

Weyaw supports today:

• Local project onboarding and task routing.
• Persistent task artifacts for plan, execution, verification, review, and consolidation.
• Project-scoped agent skills for common workflow actions.
• Roadmap and blueprint notes for project direction and design decisions.
• Health checks for workflow artifact consistency.
• Local management for incremental todo work through the project workflow workspace, normally .aw, plus constraints, process records, and task state.

Weyaw has growing support for:

• A read-only dashboard for inspecting workflow state.
• Agent coordination and longer main/worker flows when they fit the artifact-backed workflow.

Weyaw is planned to support:

• Local indexing or retrieval over existing code, specs, roadmap, and retained knowledge outside the active task loop.
• Project-management views over retained project artifacts beyond the current task loop.

Weyaw does not try to be:

• A replacement for Git history or normal source-control practice.

Common Skills

Use these prompts from an agent session in a Weyaw project:

$aw-init <project context>
$aw <task intention>
$aw-resume <task-id>
$aw-status
$aw-help
$aw-health
$aw-blueprint <design or standards update>
$aw-roadmap <roadmap update>

Typical use:

• $aw-init establishes or reconciles project context.
• $aw starts scoped task work from an intention.
• $aw-resume continues recorded work.
• $aw-status reports current workflow state.
• $aw-help suggests the next useful Weyaw action.
• $aw-health checks or repairs workflow consistency.
• $aw-blueprint updates durable design language or standards.
• $aw-roadmap updates project direction without starting implementation.

Installation

Requires Node.js 18+.

npm install -g weyaw

The correct pre-built binary for your platform is installed automatically. No Rust toolchain needed. Verify with aw --help.

See Getting Started for full details and first steps.

Documentation

• Getting Started
• Concepts
• CLI
• Skills
• Artifacts
• Dashboard
• Release

Design Principles

• Keep workflow state local to the project.
• Prefer small, explicit task steps over hidden agent memory.
• Record evidence for changes that matter.
• Keep human decisions visible.
• Treat generated and runtime artifacts as separate from source design.

Development

This repository uses Rust 1.96.0. When rustup is installed, it reads rust-toolchain.toml and selects the project toolchain automatically.

Run the focused local checks before handing off Rust changes:

cargo fmt --check
cargo test --locked --all-targets

Npm Package

The npm metadata in this repository exposes the Rust command as aw. The package remains private/local at this stage and can be linked globally for local use.

Run the focused package checks with:

npm run package:metadata-test
npm run package:smoke