aiflow-cli/README.md

Intelligent AI Assistant with Smart Model Routing - Created by DavidFon

# 🚀 AiFlow CLI

> Intelligent AI Assistant with Smart Model Routing  
> Created by [DavidFon](https://davidfon.dev) (冯志伟)

[![AiFlow CLI CI](https://github.com/DavidFon/aiflow-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/DavidFon/aiflow-cli/actions/workflows/ci.yml)

![AiFlow CLI Screenshot](./docs/assets/aiflow-screenshot.png)

## 👋 Meet the Creator

Hi! I'm **DavidFon**, a full-stack developer who got tired of expensive AI bills. 
AiFlow was born from my personal frustration with paying $300+/month for AI APIs 
when most tasks could be handled by cheaper models.

This repository contains the AiFlow CLI, an intelligent AI assistant that helps developers 
**save 75-85% on AI costs** through smart model routing while maintaining high-quality results.

**Why AiFlow?**
- 💰 Save 75-85% on AI costs through intelligent routing
- 🎯 Built by developers, for developers
- 🌟 Open source and community-driven
- 🚀 Production-ready with enterprise features

With AiFlow CLI you can:

- Query and edit large codebases with smart model selection for optimal cost-performance
- Generate new apps from PDFs or sketches using multimodal capabilities
- Automate operational tasks with intelligent cost optimization
- Use tools and MCP servers to connect new capabilities
- Leverage smart routing to use the right model for each specific task

## Quickstart

1. **Prerequisites:** Ensure you have [Node.js version 18](https://nodejs.org/en/download) or higher installed.
2. **Run the CLI:** Execute the following command in your terminal:

   ```bash
   npx https://github.com/DavidFon/aiflow-cli
   ```

   Or install it with:

   ```bash
   npm install -g aiflow-cli
   aiflow
   ```

3. **Pick a color theme**
4. **Configure your AI providers:** AiFlow supports multiple AI providers for smart routing. Configure your preferred models and API keys.

You are now ready to use AiFlow CLI with intelligent cost optimization!

### 🎯 Creator's Mission

*"Every developer deserves access to powerful AI tools without breaking the bank"* - DavidFon

### For advanced configuration:

AiFlow supports multiple AI providers for optimal cost-performance routing:

1. Configure your preferred models in the settings
2. Set up API keys for your chosen providers
3. Let AiFlow automatically route to the most cost-effective model for each task

For detailed configuration, see the [authentication](./docs/cli/authentication.md) guide.

## Examples

Once AiFlow CLI is running, you can start leveraging intelligent AI routing from your shell.

You can start a project from a new directory:

```sh
cd new-project/
aiflow
> Write me a Discord bot that answers questions using a FAQ.md file I will provide
```

Or work with an existing project:

```sh
git clone https://github.com/DavidFon/aiflow-cli
cd aiflow-cli
aiflow
> Give me a summary of all of the changes that went in yesterday
```

### Next steps

- Learn how to [contribute to or build from the source](./CONTRIBUTING.md).
- Explore the available **[CLI Commands](./docs/cli/commands.md)**.
- If you encounter any issues, review the **[Troubleshooting guide](./docs/troubleshooting.md)**.
- For more comprehensive documentation, see the [full documentation](./docs/index.md).
- Take a look at some [popular tasks](#popular-tasks) for more inspiration.

### Troubleshooting

Head over to the [troubleshooting](docs/troubleshooting.md) guide if you're
having issues.

## Popular tasks

### Explore a new codebase

Start by `cd`ing into an existing or newly-cloned repository and running `gemini`.

```text
> Describe the main pieces of this system's architecture.
```

```text
> What security mechanisms are in place?
```

### Work with your existing code

```text
> Implement a first draft for GitHub issue #123.
```

```text
> Help me migrate this codebase to the latest version of Java. Start with a plan.
```

### Automate your workflows

Use MCP servers to integrate your local system tools with your enterprise collaboration suite.

```text
> Make me a slide deck showing the git history from the last 7 days, grouped by feature and team member.
```

```text
> Make a full-screen web app for a wall display to show our most interacted-with GitHub issues.
```

### Interact with your system

```text
> Convert all the images in this directory to png, and rename them to use dates from the exif data.
```

```text
> Organise my PDF invoices by month of expenditure.
```

## 📞 Connect with DavidFon

- 🌐 Website: [davidfon.dev](https://davidfon.dev)
- 🐦 Twitter: [@DavidFon_AI](https://twitter.com/DavidFon_AI)
- 💼 LinkedIn: [DavidFon](https://linkedin.com/in/davidfon)
- 📧 Email: david@aiflow.dev
- 💻 GitHub: [DavidFon](https://github.com/DavidFon)

## Terms of Service and Privacy Notice

For details on the terms of service and privacy notice applicable to your use of AiFlow CLI, see the [Terms of Service and Privacy Notice](./docs/tos-privacy.md).