Skip to content

Add AGI command reference#771

Merged
Bryan-Roe merged 2 commits intomainfrom
codex/document-agi-command-structure
Aug 3, 2025
Merged

Add AGI command reference#771
Bryan-Roe merged 2 commits intomainfrom
codex/document-agi-command-structure

Conversation

@Bryan-Roe
Copy link
Collaborator

@Bryan-Roe Bryan-Roe commented Jul 27, 2025

Summary

  • document main AGI commands in AGI_COMMANDS.md

Testing

  • pytest --version
  • pytest test_local_agent.py -q (fails: ModuleNotFoundError: No module named 'semantic_kernel')

https://chatgpt.com/codex/tasks/task_e_6886a7beb80883229017518823b1144b

Summary by Sourcery

Add a comprehensive AGI command reference guide

Documentation:

  • Introduce AGI_COMMANDS.md detailing agi_cli.py sub-commands with examples
  • Document local_agent_launcher.py commands and interactive menu
  • Detail usage of demo_local_agents.py and agi_status_dashboard.py scripts

Copilot AI review requested due to automatic review settings July 27, 2025 22:41
@sourcery-ai
Copy link

sourcery-ai bot commented Jul 27, 2025

Reviewer's Guide

This PR adds a comprehensive AGI_COMMANDS.md reference file that documents the repository’s primary AGI CLI tools, local agent launcher, and demo/dashboard scripts, complete with command descriptions and usage examples.

Flow diagram for AGI command reference documentation structure

flowchart TD
    A[AGI_COMMANDS.md] --> B[AGI CLI]
    A --> C[Local Agent Launcher]
    A --> D[Demo and Dashboard]
    B --> B1[reason]
    B --> B2[file]
    B --> B3[code]
    B --> B4[plan]
    B --> B5[help]
    C --> C1[list]
    C --> C2[status]
    C --> C3[start]
    C --> C4[stop]
    D --> D1[demo_local_agents.py]
    D --> D2[agi_status_dashboard.py]
Loading

File-Level Changes

Change Details Files
Introduction of AGI command reference documentation
  • Created a new AGI_COMMANDS.md file
  • Documented agi_cli.py sub-commands and example invocations
  • Specified usage patterns for local_agent_launcher.py
  • Outlined demo scripts (demo_local_agents.py, agi_status_dashboard.py) and their commands
AGI_COMMANDS.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds documentation for AGI command-line tools by creating a comprehensive reference guide. The documentation describes the main scripts and their usage patterns to help users interact with the AGI tooling in the repository.

  • Adds a new documentation file with command reference for AGI CLI tools
  • Documents four main scripts: agi_cli.py, local_agent_launcher.py, demo_local_agents.py, and agi_status_dashboard.py
  • Provides usage examples and command syntax for each tool

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @Bryan-Roe - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Bryan <74067792+Bryan-Roe@users.noreply.github.com>
@Bryan-Roe Bryan-Roe merged commit 5a34878 into main Aug 3, 2025
7 of 11 checks passed
@Bryan-Roe Bryan-Roe deleted the codex/document-agi-command-structure branch August 3, 2025 08:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant