A powerful CLI tool for quickly enabling and configuring Serena coding agent tools in specified projects
Project description
🚀 Serena CLI
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 compatibilityserena-cli info- Get project informationserena-cli status- Check Serena service statusserena-cli config- Edit Serena configurationserena-cli enable- Enable Serena in projectsserena-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
- Python Version: Serena requires Python 3.11-3.12
- MCP Server: If MCP server fails, use CLI commands directly
- 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
- Fork the repository
- Create a feature branch
- Make your changes
- Add tests
- 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
Project details
Release history Release notifications | RSS feed
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 serena_cli-1.0.12.tar.gz.
File metadata
- Download URL: serena_cli-1.0.12.tar.gz
- Upload date:
- Size: 45.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8f1fa517030e799eea7b1cc36f10f323b62dbb418cecdff5c7ccac693bd7f5ac
|
|
| MD5 |
e1978cd31e472551a0a92334d04d8d4e
|
|
| BLAKE2b-256 |
e769b3131b724fff9629148d17d7a747a5b8d55af7433d6d5eec790aefbc9040
|
File details
Details for the file serena_cli-1.0.12-py3-none-any.whl.
File metadata
- Download URL: serena_cli-1.0.12-py3-none-any.whl
- Upload date:
- Size: 25.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b41f724c0e47364b0d6bc5b3c3adfa936ed789ea7338af4ab42423a8fafc111e
|
|
| MD5 |
57ddc0a5700fc1260a61bd307a14b086
|
|
| BLAKE2b-256 |
8eadb2133a6aca1c4029b15b1d0c186fd86f217bbe48d345a4779652a40aafb7
|