A smart AI-powered code scaffolding CLI for FastAPI applications. Generate production-ready CRUD features with authentication using Google Gemini AI.
Project description
🗣️ Foxie CLI
Command-line interface for the Foxie AI code generation platform.
This is the developer-facing CLI tool that provides an easy-to-use interface for code generation.
For full documentation, see the main README.
Installation
From PyPI (Recommended)
pip install foxie-cli
From Source
git clone https://github.com/foxie-platform/foxie-platform.git
cd foxie-platform/foxie-cli
pip install -e .
Quick Start
# Interactive mode
foxie scaffold fastapi-crud
# Command-line mode
foxie scaffold fastapi-crud \
-p my-project \
-r product \
-f "name:str,price:float"
Configuration
Foxie requires a Google Gemini API key to function. You can provide it in several ways:
Option 1: Interactive Configuration (Recommended)
foxie config
This will prompt you to enter your API key and save it to ~/.config/foxie/config.env for future use.
Option 2: Environment Variable
Set the GOOGLE_API_KEY environment variable:
Windows (PowerShell):
$env:GOOGLE_API_KEY="your-api-key-here"
Linux/macOS:
export GOOGLE_API_KEY="your-api-key-here"
Option 3: Project .env File
Create a .env file in your project directory:
# .env
GOOGLE_API_KEY=your-api-key-here
Option 4: Global Config File
Create ~/.config/foxie/config.env manually (follows XDG Base Directory specification):
Windows:
New-Item -Path "$HOME\.config\foxie" -ItemType Directory -Force
Set-Content -Path "$HOME\.config\foxie\config.env" -Value "GOOGLE_API_KEY=your-api-key-here"
Linux/macOS:
mkdir -p ~/.config/foxie
echo "GOOGLE_API_KEY=your-api-key-here" > ~/.config/foxie/config.env
Priority Order
Foxie checks for your API key in this order (highest priority first):
GOOGLE_API_KEYenvironment variable.envfile in current directory~/.config/foxie/config.envfile (standard config location)- Interactive prompt (if none found)
Get Your API Key
Get your Google Gemini API key from: https://makersuite.google.com/app/apikey
Backend Configuration
By default, the CLI connects to the deployed backend at https://foxie-wsj6.onrender.com. If you want to use a different backend (e.g., local development), configure the following:
Backend URL
Set the FOXIE_BACKEND_URL environment variable:
Windows (PowerShell):
$env:FOXIE_BACKEND_URL="https://your-backend-url.onrender.com"
Linux/macOS:
export FOXIE_BACKEND_URL="https://your-backend-url.onrender.com"
You can also add the backend URL to your config file (~/.config/foxie/config.env):
# ~/.config/foxie/config.env
FOXIE_BACKEND_URL=https://foxie-wsj6.onrender.com
GOOGLE_API_KEY=your-gemini-api-key-here
For local development, set the backend URL to your local instance:
# ~/.config/foxie/config.env
FOXIE_BACKEND_URL=http://127.0.0.1:8000
GOOGLE_API_KEY=your-gemini-api-key-here
Note: API keys are protected by HTTPS - When using Render, all traffic is encrypted via HTTPS/TLS, preventing interception
Usage
See the main documentation for detailed usage instructions.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file foxie_cli-0.1.5.tar.gz.
File metadata
- Download URL: foxie_cli-0.1.5.tar.gz
- Upload date:
- Size: 12.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dc2be58237fec58dec61f1ea548c2232ee5c0ab4ec6e924df71157beb88efa16
|
|
| MD5 |
3be322ee4330b2dad2085b25ff5f4751
|
|
| BLAKE2b-256 |
f65c89b0907ec093d5b884eae6cb311ec09abb3a7efe084e0823b1d4e0816442
|
File details
Details for the file foxie_cli-0.1.5-py3-none-any.whl.
File metadata
- Download URL: foxie_cli-0.1.5-py3-none-any.whl
- Upload date:
- Size: 12.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d9c66935a38199cd85b0e2b10e1f91d6bc53cd8ce0ebd2bcca88973640884a44
|
|
| MD5 |
1c2cbaa1e9cf4e672e9d2ab591f5bb84
|
|
| BLAKE2b-256 |
37ec6851bcbc6b20934d1c2f1b8e9160e75ebacc01e0f2bb9be31bca585ff08f
|