Skip to main content

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

Project description

🚀 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

🛠️ 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

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

serena_cli-1.0.12.tar.gz (45.0 kB view details)

Uploaded Source

Built Distribution

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

serena_cli-1.0.12-py3-none-any.whl (25.2 kB view details)

Uploaded Python 3

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

Hashes for serena_cli-1.0.12.tar.gz
Algorithm Hash digest
SHA256 8f1fa517030e799eea7b1cc36f10f323b62dbb418cecdff5c7ccac693bd7f5ac
MD5 e1978cd31e472551a0a92334d04d8d4e
BLAKE2b-256 e769b3131b724fff9629148d17d7a747a5b8d55af7433d6d5eec790aefbc9040

See more details on using hashes here.

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

Hashes for serena_cli-1.0.12-py3-none-any.whl
Algorithm Hash digest
SHA256 b41f724c0e47364b0d6bc5b3c3adfa936ed789ea7338af4ab42423a8fafc111e
MD5 57ddc0a5700fc1260a61bd307a14b086
BLAKE2b-256 8eadb2133a6aca1c4029b15b1d0c186fd86f217bbe48d345a4779652a40aafb7

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