[Copilot]

Description

Expanded documentation to make AI Shell usage and mode selection clearer, adding a focused usage guide and improving README navigation.

Type of Change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation update
• Performance improvement
• Code refactoring
• CI/CD changes

Related Issues

Changes Made

• Added docs/USAGE.md with CLI flag reference, mode behavior, provider setup, and safety notes.
• Updated README usage section with wapiti mode, safety/logging flags, and documentation index.
• Clarified project structure to reflect existing docs.

Testing

• Tests pass locally (python -m pytest tests/)
• Code is properly formatted (black ai_shell/ tests/)
• Linting passes (flake8 ai_shell/ tests/)
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes

Security Considerations

• This change does not introduce security vulnerabilities
• Command execution is properly validated
• No sensitive information is exposed in logs
• API keys and credentials are handled securely

Documentation

• I have updated the documentation accordingly
• I have added docstrings to new functions/classes
• Examples are updated if needed
• README.md is updated if needed

Screenshots (if applicable)

Add screenshots to help explain your changes.

Checklist

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

Additional Notes

Quick usage example:

ai-shell --mode wapiti --provider local --no-confirmation

Original prompt

make documentatioņ comprehensive

---

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

[Copilot]

Pull request overview

This PR enhances the AI Shell documentation by adding a comprehensive usage guide and restructuring the README for better navigation. The changes make it easier for users to understand command-line options, operating modes, and provider configuration.

Key changes:

• Added a new docs/USAGE.md file with detailed CLI flag reference, mode-by-mode walkthroughs, and provider setup instructions
• Updated README to include wapiti mode example and link to the new usage guide
• Replaced verbose inline configuration examples with a concise documentation index

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File	Description
docs/USAGE.md	New comprehensive usage guide covering CLI flags, all four operating modes (translator, assistant, metasploit, wapiti), provider setup, and security features
README.md	Added wapiti mode to examples, added safety/logging flag examples, replaced verbose config section with streamlined documentation index, updated project structure comment to reflect existing docs

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

There are two consecutive blank lines here, which creates inconsistent spacing within the code block. Consider removing one blank line to maintain consistent formatting throughout the example commands section.

Suggested change