lguzzon-scratchbook / auto-copilot-cli

Auto Copilot is a powerful and useful tool for developers that uses OpenAI models to translate natural language into commands, scripts, refactoring code and more that will help you achieve your goal as safely as possible.

Description

auto-copilot-cli is a versatile tool that offers several functionalities, including:

• AI chat help you quickly find and improve codebase and answer questions about codebase
• Code review
• Pre-commit for generating commit messages
• Code refactoring and linting structure of a folder or a file
• Test generation
• Shell command generation and execution
• Natural language to SQL translation

Setup

1. Install auto-copilot-cli globally:

   # using npm
   npm install -g auto-copilot-cli
   
   # using install script
   curl -s https://raw.githubusercontent.com/rsaryev/auto-copilot-cli/main/deployment/deploy.bash | bash

2. Get an API key from OpenAI.

3. Refer to the CLI usage guide to learn how to use the tool.

Commands

• code-chat <path> - AI chat with codebase usage
  • Options:
    • -p, --prompt <prompt> - Prompt for AI
• code-review - Perform code review usage - Perform code review
• test <file> - Generate test usage
  • Options:
    • -p, --prompt <prompt> - Prompt for AI
    • -o, --output <file> - Output file
• refactor <file> - Refactor code usage
  • Options:
    • -p, --prompt <prompt> - Prompt for AI
    • -o, --output <file> - Output file
• sql-translator <query> - Translate natural language to SQL usage
  • Options:
    • -o, --output <output> - Output sql file
    • -s, --schema-path <schemaPath> - Path to schema file (sql, prisma, any format)
• chat <chat> - Chat with AI usage
  • Options:
    • -p, --prompt <prompt> - Prompt for AI
• shell <goal> - Generate and execute a shell command usage
• pre-commit - Analyze git diff and generate a commit message usage
  • Options:
    • -y, --yes - Skip confirmation
• config <key> <value> - Set configuration usage
• get-config - Print configuration

Options

• -h, --help - Display help for command
• -V, --version - Output the version number

Contributing

Contributions are always welcome!