Skip to content

[docs] add awf logs command documentation#551

Merged
Mossaka merged 1 commit intomainfrom
docs/sync-logs-command-2026-02-06-4f997dab3b1f44c8
Feb 6, 2026
Merged

[docs] add awf logs command documentation#551
Mossaka merged 1 commit intomainfrom
docs/sync-logs-command-2026-02-06-4f997dab3b1f44c8

Conversation

@github-actions
Copy link
Contributor

@github-actions github-actions bot commented Feb 6, 2026

Documentation Sync - February 6, 2026

This PR synchronizes documentation with the awf logs command implementation that was added in recent releases.

Changes Made

docs/logging_quickref.md:

  • Added new "Using the AWF CLI" section at the top prominently featuring the awf logs command
  • Documented all awf logs options: -f/--follow, --format, --source, --list, --with-pid
  • Documented subcommands: awf logs stats and awf logs summary
  • Reorganized document to show CLI-first approach (built-in command) before manual Docker commands
  • Simplified PID tracking section to reference CLI section

docs/usage.md:

  • Added new "Commands" section after "Command-Line Options"
  • Documented the logs command with all its subcommands and options
  • Maintains consistency with awf logs --help output

Code Changes Referenced

The awf logs command was implemented in src/cli.ts (lines 1064-1142) with support files in src/commands/:

  • logs.ts - Main logs command
  • logs-stats.ts - Statistics aggregation
  • logs-summary.ts - Summary generation

Verification

  • ✅ Documentation matches actual CLI implementation (verified with node dist/cli.js logs --help)
  • ✅ All flags and subcommands documented
  • ✅ Examples are practical and useful
  • ✅ Consistent with existing documentation style
  • ✅ Pre-commit hooks passed (linting)

AI generated by Documentation Maintainer

@github-actions github-actions bot added ai-generated documentation Improvements or additions to documentation labels Feb 6, 2026
@Mossaka Mossaka merged commit 8976c66 into main Feb 6, 2026
@Mossaka Mossaka deleted the docs/sync-logs-command-2026-02-06-4f997dab3b1f44c8 branch February 6, 2026 06:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ai-generated documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants