🚀 Serena CLI

English | 中文

A powerful CLI tool for quickly enabling and configuring Serena coding agent tools in specified projects.

✨ Features

• 🚀 Quick Setup: Enable Serena in any project with a single command
• 🔧 Smart Detection: Automatically detects project types and configurations
• 📁 Project Management: Manage multiple projects with ease
• ⚙️ Flexible Configuration: Global and project-specific settings
• 🎯 MCP Integration: Full MCP server support for IDE integration
• 🌍 Multi-language Support: Chinese and English documentation

🎯 Quick Start

Check Environment Compatibility

serena-cli check-env

Get Project Information

serena-cli info

Check Serena Status

serena-cli status

Enable Serena in Project

serena-cli enable

📦 Installation

PyPI Installation (Simplest)

pip install serena-cli

One-Click Installation

Unix/Linux/macOS

curl -fsSL https://raw.githubusercontent.com/impanda-cookie/serena-cli/main/install.sh | bash

Windows

curl -fsSL https://raw.githubusercontent.com/impanda-cookie/serena-cli/main/install.bat | cmd

Python Script

curl -fsSL https://raw.githubusercontent.com/impanda-cookie/serena-cli/main/install.py | python3

Manual Installation

git clone https://github.com/impanda-cookie/serena-cli.git
cd serena-cli
python3 -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -e .

🎮 Basic Usage

Main Commands

• serena-cli check-env - Check environment compatibility
• serena-cli info - Get project information
• serena-cli status - Check Serena service status
• serena-cli config - Edit Serena configuration
• serena-cli enable - Enable Serena in projects
• serena-cli mcp-tools - Show available MCP tools

MCP Integration

# Start intelligent MCP server wizard (Recommended)
serena-cli start-mcp-server

# Start simplified MCP server (avoids TaskGroup issues)
serena-cli start-mcp-simple

🚀 New: Intelligent Startup Wizard! The start-mcp-server command now launches an intelligent wizard that:

• 🔍 Automatically checks your environment
• 📦 Installs missing dependencies (uv, uvx, pip)
• 🎯 Detects available AI programming workbenches
• ⚙️ Configures MCP settings for your chosen platform
• ✅ Verifies configuration and provides usage guidance

⚙️ Configuration

IDE Configuration

Cursor/VSCode

Add to your settings.json:

{
  "mcp.servers": {
    "serena-cli": {
      "command": "serena-cli",
      "args": ["start-mcp-server"],
      "env": {
        "PYTHONPATH": "${workspaceFolder}"
      }
    }
  }
}

Vim/Neovim

Use with MCP plugins for seamless integration.

🏗️ Project Structure

serena-cli/
├── src/serena_cli/          # Core source code
├── tests/                   # Test suite
├── docs/                    # Documentation
├── examples/                # Usage examples
├── install.py               # Cross-platform installer
├── install.sh               # Unix/Linux/macOS installer
├── install.bat              # Windows installer
└── README.md                # This file

🚨 Troubleshooting

Common Issues

1. Python Version: Serena requires Python 3.11-3.12
2. MCP Server: If MCP server fails, use CLI commands directly
3. Dependencies: Ensure all required packages are installed

Environment Check

serena-cli check-env

📚 Documentation

• Quick Start Guide - 5-minute quick start
• Usage Instructions - Detailed usage guide
• Project Status - Development overview

🛠️ Development

Environment Setup

git clone https://github.com/impanda-cookie/serena-cli.git
cd serena-cli
python3 -m venv venv
source venv/bin/activate
pip install -e ".[dev,test]"

Testing

pytest
pytest --cov=serena_cli

🤝 Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests
5. Submit a pull request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• Built with Click for CLI
• Enhanced with Rich for beautiful output
• Integrated with MCP for IDE support

Made with ❤️ by Panda