# 🚀 Serena CLI
[English](README.md) | [中文](README_CN.md)
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
```bash
serena-cli check-env
```
### Get Project Information
```bash
serena-cli info
```
### Check Serena Status
```bash
serena-cli status
```
### Enable Serena in Project
```bash
serena-cli enable
```
## 📦 Installation
### PyPI Installation (Simplest)
```bash
pip install serena-cli
```
### One-Click Installation
#### Unix/Linux/macOS
```bash
curl -fsSL https://raw.githubusercontent.com/impanda-cookie/serena-cli/main/install.sh | bash
```
#### Windows
```cmd
curl -fsSL https://raw.githubusercontent.com/impanda-cookie/serena-cli/main/install.bat | cmd
```
#### Python Script
```bash
curl -fsSL https://raw.githubusercontent.com/impanda-cookie/serena-cli/main/install.py | python3
```
### Manual Installation
```bash
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
```bash
# 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`:
```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
```bash
serena-cli check-env
```
## 📚 Documentation
- [Quick Start Guide](QUICK_START_EN.md) - 5-minute quick start
- [Usage Instructions](usage_instructions_EN.md) - Detailed usage guide
- [Project Status](PROJECT_STATUS.md) - Development overview
## 🛠️ Development
### Environment Setup
```bash
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
```bash
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](LICENSE) file for details.
## 🙏 Acknowledgments
- Built with [Click](https://click.palletsprojects.com/) for CLI
- Enhanced with [Rich](https://rich.readthedocs.io/) for beautiful output
- Integrated with [MCP](https://modelcontextprotocol.io/) for IDE support
---
**Made with ❤️ by Panda**
Raw data
{
"_id": null,
"home_page": null,
"name": "serena-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Panda <panda@example.com>",
"keywords": "serena, cli, mcp, coding-agent, ai-tools, project-management",
"author": null,
"author_email": "Panda <panda@example.com>",
"download_url": "https://files.pythonhosted.org/packages/e7/69/b3131b724fff9629148d17d7a747a5b8d55af7433d6d5eec790aefbc9040/serena_cli-1.0.12.tar.gz",
"platform": null,
"description": "# \ud83d\ude80 Serena CLI\n\n[English](README.md) | [\u4e2d\u6587](README_CN.md)\n\nA powerful CLI tool for quickly enabling and configuring Serena coding agent tools in specified projects.\n\n## \u2728 Features\n\n- \ud83d\ude80 **Quick Setup**: Enable Serena in any project with a single command\n- \ud83d\udd27 **Smart Detection**: Automatically detects project types and configurations\n- \ud83d\udcc1 **Project Management**: Manage multiple projects with ease\n- \u2699\ufe0f **Flexible Configuration**: Global and project-specific settings\n- \ud83c\udfaf **MCP Integration**: Full MCP server support for IDE integration\n- \ud83c\udf0d **Multi-language Support**: Chinese and English documentation\n\n## \ud83c\udfaf Quick Start\n\n### Check Environment Compatibility\n```bash\nserena-cli check-env\n```\n\n### Get Project Information\n```bash\nserena-cli info\n```\n\n### Check Serena Status\n```bash\nserena-cli status\n```\n\n### Enable Serena in Project\n```bash\nserena-cli enable\n```\n\n## \ud83d\udce6 Installation\n\n### PyPI Installation (Simplest)\n```bash\npip install serena-cli\n```\n\n### One-Click Installation\n\n#### Unix/Linux/macOS\n```bash\ncurl -fsSL https://raw.githubusercontent.com/impanda-cookie/serena-cli/main/install.sh | bash\n```\n\n#### Windows\n```cmd\ncurl -fsSL https://raw.githubusercontent.com/impanda-cookie/serena-cli/main/install.bat | cmd\n```\n\n#### Python Script\n```bash\ncurl -fsSL https://raw.githubusercontent.com/impanda-cookie/serena-cli/main/install.py | python3\n```\n\n### Manual Installation\n```bash\ngit clone https://github.com/impanda-cookie/serena-cli.git\ncd serena-cli\npython3 -m venv venv\nsource venv/bin/activate # On Windows: venv\\Scripts\\activate\npip install -e .\n```\n\n## \ud83c\udfae Basic Usage\n\n### Main Commands\n- `serena-cli check-env` - Check environment compatibility\n- `serena-cli info` - Get project information\n- `serena-cli status` - Check Serena service status\n- `serena-cli config` - Edit Serena configuration\n- `serena-cli enable` - Enable Serena in projects\n- `serena-cli mcp-tools` - Show available MCP tools\n\n### MCP Integration\n```bash\n# Start intelligent MCP server wizard (Recommended)\nserena-cli start-mcp-server\n\n# Start simplified MCP server (avoids TaskGroup issues)\nserena-cli start-mcp-simple\n```\n\n**\ud83d\ude80 New: Intelligent Startup Wizard!**\nThe `start-mcp-server` command now launches an intelligent wizard that:\n- \ud83d\udd0d Automatically checks your environment\n- \ud83d\udce6 Installs missing dependencies (uv, uvx, pip)\n- \ud83c\udfaf Detects available AI programming workbenches\n- \u2699\ufe0f Configures MCP settings for your chosen platform\n- \u2705 Verifies configuration and provides usage guidance\n\n## \u2699\ufe0f Configuration\n\n### IDE Configuration\n\n#### Cursor/VSCode\nAdd to your `settings.json`:\n```json\n{\n \"mcp.servers\": {\n \"serena-cli\": {\n \"command\": \"serena-cli\",\n \"args\": [\"start-mcp-server\"],\n \"env\": {\n \"PYTHONPATH\": \"${workspaceFolder}\"\n }\n }\n }\n}\n```\n\n#### Vim/Neovim\nUse with MCP plugins for seamless integration.\n\n## \ud83c\udfd7\ufe0f Project Structure\n```\nserena-cli/\n\u251c\u2500\u2500 src/serena_cli/ # Core source code\n\u251c\u2500\u2500 tests/ # Test suite\n\u251c\u2500\u2500 docs/ # Documentation\n\u251c\u2500\u2500 examples/ # Usage examples\n\u251c\u2500\u2500 install.py # Cross-platform installer\n\u251c\u2500\u2500 install.sh # Unix/Linux/macOS installer\n\u251c\u2500\u2500 install.bat # Windows installer\n\u2514\u2500\u2500 README.md # This file\n```\n\n## \ud83d\udea8 Troubleshooting\n\n### Common Issues\n1. **Python Version**: Serena requires Python 3.11-3.12\n2. **MCP Server**: If MCP server fails, use CLI commands directly\n3. **Dependencies**: Ensure all required packages are installed\n\n### Environment Check\n```bash\nserena-cli check-env\n```\n\n## \ud83d\udcda Documentation\n\n- [Quick Start Guide](QUICK_START_EN.md) - 5-minute quick start\n- [Usage Instructions](usage_instructions_EN.md) - Detailed usage guide\n- [Project Status](PROJECT_STATUS.md) - Development overview\n\n## \ud83d\udee0\ufe0f Development\n\n### Environment Setup\n```bash\ngit clone https://github.com/impanda-cookie/serena-cli.git\ncd serena-cli\npython3 -m venv venv\nsource venv/bin/activate\npip install -e \".[dev,test]\"\n```\n\n### Testing\n```bash\npytest\npytest --cov=serena_cli\n```\n\n## \ud83e\udd1d Contributing\n\n1. Fork the repository\n2. Create a feature branch\n3. Make your changes\n4. Add tests\n5. Submit a pull request\n\n## \ud83d\udcc4 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## \ud83d\ude4f Acknowledgments\n\n- Built with [Click](https://click.palletsprojects.com/) for CLI\n- Enhanced with [Rich](https://rich.readthedocs.io/) for beautiful output\n- Integrated with [MCP](https://modelcontextprotocol.io/) for IDE support\n\n---\n\n**Made with \u2764\ufe0f by Panda**\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A powerful CLI tool for quickly enabling and configuring Serena coding agent tools in specified projects",
"version": "1.0.12",
"project_urls": {
"Changelog": "https://github.com/impanda-cookie/serena-cli/blob/main/CHANGELOG.md",
"Documentation": "https://github.com/impanda-cookie/serena-cli#readme",
"Download": "https://pypi.org/project/serena-cli/#files",
"Homepage": "https://github.com/impanda-cookie/serena-cli",
"Issues": "https://github.com/impanda-cookie/serena-cli/issues",
"Repository": "https://github.com/impanda-cookie/serena-cli"
},
"split_keywords": [
"serena",
" cli",
" mcp",
" coding-agent",
" ai-tools",
" project-management"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "8eadb2133a6aca1c4029b15b1d0c186fd86f217bbe48d345a4779652a40aafb7",
"md5": "57ddc0a5700fc1260a61bd307a14b086",
"sha256": "b41f724c0e47364b0d6bc5b3c3adfa936ed789ea7338af4ab42423a8fafc111e"
},
"downloads": -1,
"filename": "serena_cli-1.0.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "57ddc0a5700fc1260a61bd307a14b086",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 25190,
"upload_time": "2025-08-16T10:35:30",
"upload_time_iso_8601": "2025-08-16T10:35:30.072997Z",
"url": "https://files.pythonhosted.org/packages/8e/ad/b2133a6aca1c4029b15b1d0c186fd86f217bbe48d345a4779652a40aafb7/serena_cli-1.0.12-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e769b3131b724fff9629148d17d7a747a5b8d55af7433d6d5eec790aefbc9040",
"md5": "e1978cd31e472551a0a92334d04d8d4e",
"sha256": "8f1fa517030e799eea7b1cc36f10f323b62dbb418cecdff5c7ccac693bd7f5ac"
},
"downloads": -1,
"filename": "serena_cli-1.0.12.tar.gz",
"has_sig": false,
"md5_digest": "e1978cd31e472551a0a92334d04d8d4e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 44962,
"upload_time": "2025-08-16T10:35:32",
"upload_time_iso_8601": "2025-08-16T10:35:32.729182Z",
"url": "https://files.pythonhosted.org/packages/e7/69/b3131b724fff9629148d17d7a747a5b8d55af7433d6d5eec790aefbc9040/serena_cli-1.0.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-16 10:35:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "impanda-cookie",
"github_project": "serena-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "serena-cli"
}
JSON
