Skip to main content

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):

  1. GOOGLE_API_KEY environment variable
  2. .env file in current directory
  3. ~/.config/foxie/config.env file (standard config location)
  4. 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

foxie_cli-0.1.1.tar.gz (12.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

foxie_cli-0.1.1-py3-none-any.whl (12.0 kB view details)

Uploaded Python 3

File details

Details for the file foxie_cli-0.1.1.tar.gz.

File metadata

  • Download URL: foxie_cli-0.1.1.tar.gz
  • Upload date:
  • Size: 12.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for foxie_cli-0.1.1.tar.gz
Algorithm Hash digest
SHA256 ad43ee453e6f3f4688a9267530d9507f10cfbfc93acc21736ff1f05c85b427f2
MD5 5dbf1ef1734baeb42360c265c874b97e
BLAKE2b-256 3515edea11b284570ce481e106607c7adcb7a6ebdffd63437abbb8303840ab89

See more details on using hashes here.

File details

Details for the file foxie_cli-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: foxie_cli-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 12.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for foxie_cli-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 060630b1b5595e90eff01ad855159e5999df702539e8b247b8938154e25cba87
MD5 63d4f818c289bbf4f1ffd06a9f8779b3
BLAKE2b-256 1832b5461a5b419357fb50f28097450d1f325137d6b258d3969c5e39c7848b23

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page