Skip to content

Quick Start

Get Sentinel CI up and running in 5 minutes!

Prerequisites

  • Python 3.10 or higher
  • pip (Python package manager)
  • Access to at least one CI platform (Jenkins, GitHub Actions, or GitLab CI)

Installation

1. Clone the Repository

git clone https://github.com/kiranreddi/sentinel-ci.git
cd sentinel-ci

2. Install Dependencies

pip install -r requirements.txt

3. Configure Environment

Copy the example environment file:

cp .env.example .env

Edit .env with your credentials:

# Choose your platform
CI_PLATFORM=jenkins

# Jenkins example
JENKINS_URL=https://jenkins.example.com
JENKINS_TOKEN=username:your_api_token

See Configuration Guide for detailed setup instructions.

Running the Demo

Test your setup with the demo:

PYTHONPATH=. python3 examples/demo.py

You should see beautiful ASCII art and mock data demonstrating all features!

Integration with Claude Desktop

Add to your Claude Desktop configuration (~/Library/Application Support/Claude/claude_desktop_config.json on macOS):

{
  "mcpServers": {
    "sentinel-ci": {
      "command": "python",
      "args": ["-m", "sentinel_ci.server"],
      "env": {
        "CI_PLATFORM": "jenkins",
        "JENKINS_URL": "https://jenkins.example.com",
        "JENKINS_TOKEN": "user:token"
      }
    }
  }
}

Restart Claude Desktop and you're ready to go!

First Commands

Try these commands in Claude:

Check CI Health

Check the health of my Jenkins server

List Jobs

Show me all jobs in Jenkins

Analyze Failed Build

Analyze the failed build #42 of backend-service

Next Steps

Troubleshooting

Common Issues

ModuleNotFoundError

Make sure you've installed all dependencies: 

pip install -r requirements.txt

Authentication Failed

Verify your credentials in .env: - Check URL format (no trailing slash) - Ensure token has correct format - Test token with curl/browser

Connection Timeout

Check network connectivity: - VPN required? - Firewall blocking? - Correct URL?

For more help, visit GitHub Discussions.