Skip to content

[cli-consistency] Missing Documentation: hash-frontmatter Command #14143

@github-actions

Description

@github-actions

Issue Description

Command: gh aw hash-frontmatter
Type: Missing documentation
Priority: Medium

The hash-frontmatter command exists in the codebase and is fully functional but is completely missing from the CLI documentation (docs/src/content/docs/setup/cli.md). Users cannot discover this utility command.

Evidence from Source Code

File: pkg/cli/hash_command.go
Use: hash-frontmatter (workflow)
Short description: "Compute frontmatter hash for a workflow"
Registration:

  • cmd/gh-aw/main.go line 564: hashCmd := cli.NewHashCommand()
  • Line 599: hashCmd.GroupID = "utilities"
  • Line 628: rootCmd.AddCommand(hashCmd)

Current State vs Expected State

Aspect Current Expected
Implementation ✅ Fully implemented ✅ Fully implemented
Registration ✅ Registered in main.go ✅ Registered in main.go
Documentation Missing entirely ✅ Should be in cli.md under "### Utility Commands"

Impact

Users are missing out on a useful utility for detecting configuration changes between compilation and execution. The command computes deterministic SHA-256 hashes of workflow frontmatter including:

  • All frontmatter fields from the main workflow
  • Frontmatter from all imported workflows (BFS traversal)
  • Template expressions containing env. or vars. from the markdown body
  • Version information (gh-aw, awf, agents)

Suggested Fix

Add documentation section in docs/src/content/docs/setup/cli.md under the "### Utility Commands" section (after the project command documentation):

#### `hash-frontmatter`

Compute a deterministic SHA-256 hash of workflow frontmatter for detecting configuration changes.

```bash wrap
gh aw hash-frontmatter my-workflow.md
gh aw hash-frontmatter .github/workflows/audit-workflows.md
```

The hash includes:
- All frontmatter fields from the main workflow
- Frontmatter from all imported workflows (BFS traversal)
- Template expressions containing env. or vars. from the markdown body
- Version information (gh-aw, awf, agents)

The hash can be used to detect configuration changes between compilation and execution.

Files to Modify

AI generated by CLI Consistency Checker

  • expires on Feb 8, 2026, 1:35 PM UTC

Metadata

Metadata

Labels

automationclicookieIssue Monster Loves Cookies!documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions