README.template.md

{{ .Name }}

{{ .Short }}

---

Installation | Documentation | Contributing

---

Demo

magi-cli is a command-line interface tool designed to enhance programmer productivity by leveraging AI capabilities. Built with Go, it provides a suite of commands that help automate and streamline common programming tasks.

Key Features

• AI-assisted code generation
• Smart code analysis
• Project scaffolding
• Documentation assistance
• Code review suggestions
• And more...

Installation

Windows

go install github.com/MagdielCAS/magi-cli@latest

macOS

curl -sSL https://raw.githubusercontent.com/MagdielCAS/magi-cli/main/scripts/install.sh | bash

Linux

curl -sSL https://raw.githubusercontent.com/MagdielCAS/magi-cli/main/scripts/install.sh | bash

Quick Start

1. Set up your OpenAI API key:

{{ .Name }} config set api-key your-api-key

2. Verify installation:

{{ .Name }} --version

Usage

{{ .Name }} [command] [flags]

For detailed documentation of all available commands:

{{ .Name }} --help

Configuration

{{ .Name }} uses a configuration file located at $HOME/.{{ .Name }}/config.yaml. You can modify settings using:

{{ .Name }} config [key] [value]

You can also create a local configuration file for project-specific settings:

{{ .Name }} config init

Support

• 📫 Report issues on [GitHub Issues](https://github.com/{{ .ProjectPath }}/issues)
• 💬 Join discussions in [GitHub Discussions](https://github.com/{{ .ProjectPath }}/discussions)

Acknowledgments

• Built with Cobra
• Configuration managed by Viper
• Powered by OpenAI compatible APIs