Skip to content

ravvdevv/NeuroCLI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NeuroCLI

License: MIT Go Report Card Go Reference

Go-based AI CLI tools to automate dev workflows and shell commands.

NeuroCLI is an AI-powered command line assistant designed to enhance developer productivity by providing intelligent assistance directly in your terminal. It combines the power of AI with practical command-line utilities to streamline development workflows.

🌟 Features

  • Natural Language Processing: Interact with AI using natural language
  • Code Generation: Generate code snippets in multiple programming languages
  • Git Integration: AI-powered git operations (diffs, commits, etc.)
  • Interactive Shell: Built-in shell with command history and completion
  • Cross-Platform: Works on Windows, macOS, and Linux

🚀 Installation

Prerequisites

  • Go 1.16 or later
  • Git (for version control features)

Using Go (Recommended)

  1. Ensure you have Go 1.16 or later installed. Check your Go version:

    go version
  2. Install the latest version of NeuroCLI:

    go install github.com/Ravsalt/neurocli@latest
  3. Add Go's bin directory to your PATH if it's not already there:

    • Linux/macOS: Add this to your ~/.bashrc, ~/.zshrc, or equivalent:
      export PATH="$PATH:$(go env GOPATH)/bin"
    • Windows: Add %USERPROFILE%\go\bin to your system's PATH
  4. Verify the installation:

    neurocli --version

    Or check the help:

    neurocli --help
  5. You can now use NeuroCLI from any terminal window. Try it out:

    neurocli ask "how do I sort a map in Go?"

Building from Source

git clone https://github.com/Ravsalt/neurocli.git
cd neurocli
go build -o neurocli .
sudo mv neurocli /usr/local/bin/  # Optional: Add to PATH

🛠️ Usage

Interactive Shell

Launch the interactive shell:

neurocli shell

Generate Code

Generate code from a description:

neurocli gen -l python -o script.py "function that reverses a string"

Git Operations

Generate a commit message for staged changes:

git add .
neurocli aicommit

Explain git changes:

neurocli ai-diff

Ask Questions

Get answers to programming questions:

neurocli ask "how do I sort a map in Go?"

🏗️ Built With

  • Cobra - CLI framework
  • Pterm - Beautiful terminal output
  • Liner - Command line editor
  • Viper - Configuration management

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

👏 Acknowledgments

📧 Contact

Raven - @Ravsalt

Project Link: https://github.com/Ravsalt/neurocli

About

Go-based AI CLI tools to automate dev workflows and shell commands

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages