agentic-workflows

module
v0.54.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 6, 2026 License: AGPL-3.0

README

awf

CI Go

awf is a small Go CLI that projects repository-owned agent guidance, routes paths to current topics, inspects routing coverage for chosen paths, keeps optional local effort memory, and creates optional plan, ADR, and topic starters.

AWF supplies default agent commit guidance in the shared generated AGENTS.md frame; agents execute Git operations under repository conventions. The CLI performs no Git operations and does not manage reviews, repository gates, hooks, CI, migrations, or document meaning. It works without Git or external agent skills once its pinned binary is available.

Start

Starting with the first release that includes awf.sh, read the integration guide through the latest published launcher without installing AWF into PATH:

curl -fsSL https://github.com/hypnotox/agentic-workflows/releases/latest/download/awf.sh | bash -s -- docs integration

The launcher selects its concrete release, downloads and verifies that release's platform archive and checksums, caches the binary under ${XDG_CACHE_HOME:-$HOME/.cache}/awf/<version>/awf, and forwards the command. Reading documentation does not modify the repository. Follow the guide before explicitly running init in a repository.

Alternatively, download an archive from the latest release, extract awf, and run the binary directly. AWF supports Linux and macOS on amd64 and arm64.

Initialization creates .awf/project.md, the fixed generated guidance, and a repository-local ./awf wrapper pinned to that release. Commit sources and generated outputs together.

Documentation

The authoritative adopter guides are ordinary Markdown embedded in every binary and readable here:

  • AWF guide: purpose, source/generated ownership, render/check, and guide discovery;
  • Integration: adoption, repository-owned hooks and CI, updates, and repair;
  • Topics: path-routed current project knowledge, topic creation, and optional coverage inspection;
  • Efforts: optional local continuity, standalone tracked plans, durable ADRs, and worktrees;
  • Migrating from v0.50: one-time conversion and legacy cleanup.

Use ./awf docs, ./awf docs integration, ./awf docs topics, and ./awf docs effort inside an adopting repository. Generated AGENTS.md and the Pi and Claude skill entrypoints route agents to these guides without duplicating their runbooks.

Development

Contributors should read AGENTS.md. Development uses ./x so commands execute the checkout source rather than the released wrapper:

./x docs integration
./x test
./x gate
./x render
./x check

Current implementation guidance lives in .awf/topics/, release history in CHANGELOG.md, and the source-format migration in MIGRATING-v0.50.md.

Status

AWF is pre-1.0. Source formats and generated output may change between releases; incompatible changes use explicit manual migration guidance.

License

GNU Affero General Public License v3.0 only © hypnotox.

AWF interoperates with third-party coding agents and is not affiliated with or endorsed by their vendors.

Directories

Path Synopsis
cmd
awf command
Command awf projects a small .awf source tree into agent guidance.
Command awf projects a small .awf source tree into agent guidance.
Package docs provides the adopter guides embedded in the AWF binary.
Package docs provides the adopter guides embedded in the AWF binary.
internal
artifactfs
Package artifactfs creates author-owned plan, decision, and topic scaffolds.
Package artifactfs creates author-owned plan, decision, and topic scaffolds.
effortfs
Package effortfs manages filesystem-resident effort memory beneath a repository root.
Package effortfs manages filesystem-resident effort memory beneath a repository root.
frontmatter
Package frontmatter splits and parses YAML frontmatter delimited by leading "---" lines in markdown content.
Package frontmatter splits and parses YAML frontmatter delimited by leading "---" lines in markdown content.
pathglob
Package pathglob provides anchored full-path doublestar matching against slash-separated repository-relative paths.
Package pathglob provides anchored full-path doublestar matching against slash-separated repository-relative paths.
projector
Package projector loads AWF sources and projects the fixed generated surface.
Package projector loads AWF sources and projects the fixed generated surface.
tools
release-assets command

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL