⚙️ Zero Setup

Simply provide your API key, and it just works!

export API_KEY="your_api_key"

[!IMPORTANT] Codai use OpenApi as a default model and with subcommand --provider you can choose your appropriate model and use subcommand --model for choosing appropriate model of each provider.

• OpenAI
• Ollama
• Azure OpenAI
• Anthropic
• Gemini
• Mistral
• Grok
• Qwen
• DeepSeek
• OpenRouter

🔧 Advance Configuration

For more advance configuration add a codai-config.yml file in the root of your working directory or using environment variables to set below configs globally as a configuration.

The codai-config file should be like following example base on your AI provider:

codai-config.yml

ai_provider_config:
  provider: "azure-openai"
  base_url: "https://test.openai.azure.com"
  model: "gpt-4o"
  api_version: "2024-04-01-preview"     #(Optional, If your AI provider like 'AzureOpenai' or 'Anthropic' has chat api version.)
  temperature: 0.2     #(Optional, If you want use 'Temperature'.)
  reasoning_effort: "low"     #(Optional, If you want use 'Reasoning'.) 
theme: "dracula"

If you wish to customize your configuration, you can create your own codai-config.yml file and place it in the root directory of each project you want to analyze with codai. If no configuration file is provided, codai will use the default settings.

You can also specify a configuration file from any directory by using the following CLI command:

codai code --config ./codai-config.yml

Additionally, you can pass configuration options directly in the command line. For example:

codai code --provider openapi --temperature 0.8 --api_key test-key

This flexibility allows you to customize config of codai on the fly.

.codai-gitignore

Also, you can use .codai-gitignore in the root of your working directory, and codai will ignore the files that we specify in our .codai-gitignore.

[!NOTE] We used Chroma for style of our text and code block, and you can find more theme here in Chroma Style Gallery and use it as a theme in codai.

▶️ How to Run

To use codai as your code assistant, navigate to the directory where you want to apply codai and run the following command:

codai code

This command will initiate the codai assistant to help you with your coding tasks with understanding the context of your code.

🗺️ Plan

🌀 This project is a work in progress; new features will be added over time. 🌀

I will try to add new features in the Issues section of this app.

🌟 Support

If you like my work, feel free to:

• ⭐ this repository. And we will be happy together :)

Thanks a bunch for supporting me!

🤝 Contribution

Thanks to all contributors, you're awesome and this wouldn't be possible without you! The goal is to build a categorized, community-driven collection of very well-known resources.

Please follow this contribution guideline to submit a pull request or create the issue.