Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 

README.md

⚡ @free-ai-gateway/cli

Developer CLI tool for Free-AI Gateway: interactive terminal AI, provider diagnostics, and model querying.

npm version License: MIT TypeScript


📖 Overview

@free-ai-gateway/cli provides instant access to Free-AI Gateway directly from your terminal. Query free-tier AI models, start interactive chat sessions with automatic fallback, inspect discovered provider models, check API key health, and install IDE skills.


📦 Quick Start & Usage

1. Run without installation via npx

# Ask a direct question with auto-routing
npx @free-ai-gateway/cli "Explain MapReduce in simple terms"

# Run with specific capability
npx @free-ai-gateway/cli prompt "Write a quicksort in TypeScript" --capability=code

# Start an interactive terminal chat session
npx @free-ai-gateway/cli chat --capability=reasoning

# Check model catalog across all 19 providers
npx @free-ai-gateway/cli models

# Run system diagnostics & check API key readiness
npx @free-ai-gateway/cli doctor

# Install IDE skills
npx @free-ai-gateway/cli skills install --target=antigravity

2. Global Installation

npm install -g @free-ai-gateway/cli

# Now use 'free-ai' or 'freeai' anywhere
free-ai "Hello from my terminal!"
free-ai chat
free-ai models
free-ai doctor

🛠️ CLI Commands & Flags

Command Description Example
prompt <text> Execute a one-off prompt with capability routing free-ai prompt "Summarize this article" --capability=text
chat Interactive terminal chat REPL free-ai chat --capability=reasoning
models List all available models, providers, and capabilities free-ai models
doctor Check configured API keys and provider readiness free-ai doctor
skills Install agent skills to Antigravity, Cursor, Claude free-ai skills install --target=all

Command Options:

  • --capability=<cap>: Specify required capability (text, code, reasoning, vision, tool_calling, etc.)
  • --provider=<id>: Force preferred provider (e.g. groq, google, sambanova, openrouter)
  • --model=<id>: Force specific model identifier
  • --help, -h: Show help manual
  • --version, -v: Print CLI version

📄 License

MIT © Md. Mahedi Zaman Zaber