Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rsaryev/auto-copilot-cli
https://github.com/rsaryev/auto-copilot-cli
chatgpt cli javascript nodejs npm openai tools typescript
Last synced: 4 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/rsaryev/auto-copilot-cli
- Owner: rsaryev
- License: mit
- Created: 2023-04-30T22:04:58.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-29T19:45:17.000Z (3 months ago)
- Last Synced: 2025-01-11T09:05:38.571Z (11 days ago)
- Topics: chatgpt, cli, javascript, nodejs, npm, openai, tools, typescript
- Language: TypeScript
- Homepage:
- Size: 17 MB
- Stars: 374
- Watchers: 16
- Forks: 18
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-ChatGPT-repositories - auto-copilot-cli - Auto Copilot is a CLI tool that uses OpenAI models to generate commands for the terminal and file system operations to achieve a goal. (CLIs)
README
[](https://www.npmjs.com/package/auto-copilot-cli)
[](https://github.com/rsaryev/auto-copilot-cli/actions/workflows/npm-publish.yml)
[](https://github.com/transitive-bullshit/chatgpt-api/blob/main/license)
[](https://www.npmjs.com/package/auto-copilot-cli)
## 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:
```bash
# 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](https://platform.openai.com/account/api-keys).
3. Refer to the [CLI usage](https://github.com/rsaryev/auto-copilot-cli/tree/main/docs) guide to learn how to use
the tool.
### Commands
- `code-chat ` - AI chat with codebase [usage](https://github.com/rsaryev/auto-copilot-cli/blob/main/docs/code-chat.md)
- Options:
- `-p, --prompt ` - Prompt for AI
- `code-review` - Perform code review [usage](https://github.com/rsaryev/auto-copilot-cli/blob/main/docs/code-review.md) - Perform code review
- `test ` - Generate test [usage](https://github.com/rsaryev/auto-copilot-cli/blob/main/docs/test.md)
- Options:
- `-p, --prompt ` - Prompt for AI
- `-o, --output ` - Output file
- `refactor ` - Refactor code [usage](https://github.com/rsaryev/auto-copilot-cli/blob/main/docs/refactor.md)
- Options:
- `-p, --prompt ` - Prompt for AI
- `-o, --output ` - Output file
- `sql-translator ` - Translate natural language to SQL [usage](https://github.com/rsaryev/auto-copilot-cli/blob/main/docs/sql-translator.md)
- Options:
- `-o, --output ` - Output sql file
- `-s, --schema-path ` - Path to schema file (sql, prisma, any format)
- `chat ` - Chat with AI [usage](https://github.com/rsaryev/auto-copilot-cli/blob/main/docs/chat.md)
- Options:
- `-p, --prompt ` - Prompt for AI
- `shell ` - Generate and execute a shell command [usage](https://github.com/rsaryev/auto-copilot-cli/blob/main/docs/shell.md)
- `pre-commit` - Analyze git diff and generate a commit message [usage](https://github.com/rsaryev/auto-copilot-cli/blob/main/docs/pre-commit.md)
- Options:
- `-y, --yes` - Skip confirmation
- `config ` - Set configuration [usage](https://github.com/rsaryev/auto-copilot-cli/blob/main/docs/config.md)
- `get-config` - Print configuration
### Options
- `-h, --help` - Display help for command
- `-V, --version` - Output the version number
## Contributing
Contributions are always welcome!