Skip to main content

CLI Installation

The is the command-line interface for SpoonAI, providing an easy way to interact with AI agents, manage configurations, and perform various operations.

Installation Methods​

pip install spoon-cli

This installs the latest stable version of along with all necessary dependencies.

Method 2: Install from Source​

If you want to install from source or contribute to development:

# Clone the repository
git clone https://github.com/XSpoonAi/spoon-cli.git
cd spoon-cli/
# Install in development mode
pip install -e .

System Requirements​

Minimum Requirements​

  • Python: 3.11 or higher
  • Operating System: Linux, macOS, or Windows
  • Memory: 4GB RAM minimum, 8GB recommended
  • Disk Space: 500MB for installation
  • Python: 3.12+
  • Memory: 16GB RAM
  • CPU: Multi-core processor

Dependencies​

The automatically installs the following core dependencies:

  • spoon-ai-sdk: Core SpoonAI framework
  • spoon-toolkits: Additional tool collections
  • prompt_toolkit: Enhanced command-line interface
  • python-dotenv: Environment variable management
  • fastmcp: MCP (Model Context Protocol) support
  • pydantic: Data validation
  • websockets: WebSocket communication

Verification​

After installation, verify the installation by checking the version:

# Check version
spoon-cli --version

Or start the interactive CLI:

# Start spoon-cli
spoon-cli

Post-Installation Setup​

1. Configure Environment Variables​

Create a .env file in your project directory or set environment variables:

# LLM API Keys (choose at least one)
export OPENAI_API_KEY="sk-your-openai-key"
export ANTHROPIC_API_KEY="sk-ant-your-anthropic-key"
export DEEPSEEK_API_KEY="your-deepseek-key"

# Optional: Blockchain operations
export PRIVATE_KEY="your-wallet-private-key"
export RPC_URL="https://mainnet.infura.io/v3/YOUR_PROJECT_ID"

2. Create Configuration File​

Create a config.json file for advanced configuration (optional but recommended):

{
  "default_agent": "react",
  "api_keys": {
    "openai": "sk-your-key-here"
  }
}

3. Test Installation​

Run the system health check:

# Start spoon-cli and run:
system-info

This command will show:

  • System information
  • Environment variable status
  • Configuration file status
  • Available agents and tools

Troubleshooting Installation​

Common Issues​

  1. Python Version Too Old
python --version
# Should show 3.11 or higher
  1. Permission Denied
# Use user installation
pip install --user
# Or use virtual environment
python -m venv spoon_env
source spoon_env/bin/activate  # Linux/macOS
# spoon_env\Scripts\activate    # Windows
pip install
  1. Dependency Conflicts
# Upgrade pip
pip install --upgrade pip

# Install in isolated environment
pip install --isolated

Windows-Specific Issues​

On Windows, you might need to:

  1. Add Python to PATH during installation
  2. Use Command Prompt or PowerShell instead of bash
  3. Install Microsoft Visual C++ Redistributable if required

Upgrading​

To upgrade to the latest version:

pip install --upgrade spoon-cli

Uninstalling​

To remove spoon-cli:

pip uninstall spoon-cli

Note: This will not remove configuration files or chat histories you may have created.

Next Steps​

After installation, proceed to: