Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 | 2x 2x 2x 2x 2x 38x 38x 38x 38x 1x 37x 2x 6x 6x 6x 6x 1x 1x 1x 5x 5x 5x 1x 1x 4x 4x 2x 2x 2x 2x 2x 1x 2x 4x 4x 1x 1x 1x 1x 1x 1x 3x 4x 2x 10x 10x 10x 2x 2x 2x 2x 8x 1x 1x 1x 1x 7x 7x 1x 1x 6x 6x 1x 1x 5x 1x 1x 1x 5x 5x 5x 5x 5x 4x 4x 4x 4x 1x 1x 3x 2x 2x 2x 1x 1x 1x 3x 1x 1x 2x 3x 3x 3x 2x 2x 1x 1x 2x 3x 3x 3x 2x 1x 2x 3x 3x 3x 2x 1x 2x 3x 3x 3x 2x 1x 2x 7x 3x 3x 3x 1x 4x 4x 3x 1x 2x 22x 22x 10x 12x 18x 1x 17x 17x 17x 17x 10x 31x 5x 5x 7x 4x 3x 12x 1x 1x 11x 21x 21x 1x 1x 20x 20x 1x 1x 19x 5x 5x 1x 1x 4x 4x 4x 18x 18x 1x 1x 17x 17x 17x 17x 2x 3x 2x 2x 1x 2x 13x 13x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 3x 3x 3x 3x 3x 1x 1x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x | /**
* Docker subcommands for gitlab-mcp CLI
*/
import * as p from "@clack/prompts";
import { randomBytes } from "crypto";
import {
getDockerStatus,
startContainer,
stopContainer,
restartContainer,
upgradeContainer,
getLogs,
tailLogs,
addInstance,
removeInstance,
initDockerConfig,
getExpandedConfigDir,
} from "./docker-utils";
import { GitLabInstance, DEFAULT_DOCKER_CONFIG } from "./types";
/**
* Docker subcommand type
*/
export type DockerSubcommand =
| "status"
| "init"
| "start"
| "stop"
| "restart"
| "upgrade"
| "logs"
| "add-instance"
| "remove-instance";
/**
* Parse docker subcommand from CLI args
*/
export function parseDockerSubcommand(args: string[]): {
subcommand: DockerSubcommand | undefined;
subArgs: string[];
} {
const subcommand = args[0] as DockerSubcommand | undefined;
const subArgs = args.slice(1);
const validSubcommands: DockerSubcommand[] = [
"status",
"init",
"start",
"stop",
"restart",
"upgrade",
"logs",
"add-instance",
"remove-instance",
];
if (subcommand && !validSubcommands.includes(subcommand)) {
return { subcommand: undefined, subArgs: args };
}
return { subcommand, subArgs };
}
/**
* Show Docker status
*/
export function showStatus(): void {
const status = getDockerStatus();
console.log("\nDocker Environment:");
console.log(` Docker installed: ${status.dockerInstalled ? "✓" : "✗"}`);
if (!status.dockerInstalled) {
console.log("\n⚠ Docker is not installed. Install Docker first.");
console.log(" https://docs.docker.com/get-docker/");
return;
}
console.log(` Docker running: ${status.dockerRunning ? "✓" : "✗"}`);
console.log(` Compose installed: ${status.composeInstalled ? "✓" : "✗"}`);
if (!status.dockerRunning) {
console.log("\n⚠ Docker daemon is not running. Start Docker first.");
return;
}
console.log("\nContainer Status:");
if (status.container) {
const c = status.container;
console.log(` Name: ${c.name}`);
console.log(` Status: ${c.status}${c.uptime ? ` (${c.uptime})` : ""}`);
console.log(` Image: ${c.image}`);
if (c.ports.length > 0) {
console.log(` Ports: ${c.ports.join(", ")}`);
}
} else {
console.log(" Container not found. Run 'gitlab-mcp docker init' to set up.");
}
console.log("\nConfigured Instances:");
if (status.instances.length > 0) {
for (const instance of status.instances) {
console.log(` ${instance.host}: ${instance.name}`);
Eif (instance.oauth) {
console.log(` OAuth: enabled`);
}
Eif (instance.defaultPreset) {
console.log(` Preset: ${instance.defaultPreset}`);
}
}
} else {
console.log(" No instances configured.");
}
console.log(`\nConfig directory: ${getExpandedConfigDir()}`);
}
/**
* Initialize Docker configuration interactively
*/
export async function initDocker(): Promise<void> {
p.intro("Initialize GitLab MCP Docker Setup");
// Check Docker prerequisites
const status = getDockerStatus();
if (!status.dockerInstalled) {
p.log.error("Docker is not installed.");
p.note("Visit https://docs.docker.com/get-docker/ to install Docker.", "Install Docker");
p.outro("Setup cancelled.");
return;
}
if (!status.composeInstalled) {
p.log.error("Docker Compose is not installed.");
p.note(
"Docker Compose is required. Install it with:\n docker compose version (v2, bundled with Docker Desktop)\n or\n pip install docker-compose (v1)",
"Install Compose"
);
p.outro("Setup cancelled.");
return;
}
// Port configuration
const port = await p.text({
message: "SSE port for MCP server:",
placeholder: "3333",
initialValue: "3333",
validate: value => {
const num = parseInt(value ?? "", 10);
if (isNaN(num) || num < 1 || num > 65535) {
return "Port must be a number between 1 and 65535";
}
return undefined;
},
});
if (p.isCancel(port)) {
p.cancel("Setup cancelled");
return;
}
// OAuth configuration
const enableOAuth = await p.confirm({
message: "Enable OAuth for multi-instance support?",
initialValue: false,
});
if (p.isCancel(enableOAuth)) {
p.cancel("Setup cancelled");
return;
}
let oauthSessionSecret: string | undefined;
if (enableOAuth) {
p.note(
"OAuth mode allows users to authenticate with multiple GitLab instances.\n" +
"You'll need to register OAuth applications on each GitLab instance.",
"OAuth Mode"
);
// Generate session secret
oauthSessionSecret = randomBytes(32).toString("hex");
p.log.warn(
"Session secret will be stored in docker-compose.yml. Keep this file secure and do NOT commit to version control."
);
}
// Create configuration
const config = {
...DEFAULT_DOCKER_CONFIG,
port: parseInt(port, 10),
oauthEnabled: enableOAuth,
oauthSessionSecret,
};
const spinner = p.spinner();
spinner.start("Creating Docker configuration...");
try {
initDockerConfig(config);
spinner.stop("Docker configuration created!");
p.log.success(`Config directory: ${getExpandedConfigDir()}`);
// Ask to start container
const startNow = await p.confirm({
message: "Start the container now?",
initialValue: true,
});
if (p.isCancel(startNow)) {
p.cancel("Setup complete without starting container");
return;
}
if (startNow) {
spinner.start("Starting container...");
const result = startContainer();
if (result.success) {
spinner.stop("Container started!");
} else {
spinner.stop("Failed to start container");
p.log.error(result.error ?? "Unknown error");
}
}
p.outro("Docker setup complete!");
} catch (error) {
spinner.stop("Configuration failed");
p.log.error(error instanceof Error ? error.message : String(error));
}
}
/**
* Start container
*/
export function dockerStart(): void {
console.log("Starting gitlab-mcp container...");
const result = startContainer();
if (result.success) {
console.log("✓ Container started");
if (result.output) {
console.log(result.output);
}
} else {
console.error(`✗ Failed to start container: ${result.error}`);
}
}
/**
* Stop container
*/
export function dockerStop(): void {
console.log("Stopping gitlab-mcp container...");
const result = stopContainer();
if (result.success) {
console.log("✓ Container stopped");
} else {
console.error(`✗ Failed to stop container: ${result.error}`);
}
}
/**
* Restart container
*/
export function dockerRestart(): void {
console.log("Restarting gitlab-mcp container...");
const result = restartContainer();
if (result.success) {
console.log("✓ Container restarted");
} else {
console.error(`✗ Failed to restart container: ${result.error}`);
}
}
/**
* Upgrade container (pull + restart)
*/
export function dockerUpgrade(): void {
console.log("Upgrading gitlab-mcp container...");
const result = upgradeContainer();
if (result.success) {
console.log("✓ Container upgraded to latest version");
} else {
console.error(`✗ Failed to upgrade container: ${result.error}`);
}
}
/**
* Show container logs
*/
export function dockerLogs(follow: boolean = false, lines: number = 100): void {
if (follow) {
console.log(`Tailing logs (last ${lines} lines, Ctrl+C to exit)...\n`);
const process = tailLogs(true, lines);
process.on("error", error => {
console.error(`Failed to get logs: ${error.message}`);
});
} else {
const result = getLogs(lines);
if (result.success) {
console.log(result.output);
} else {
console.error(`Failed to get logs: ${result.error}`);
}
}
}
/**
* Add GitLab instance interactively
*/
export async function dockerAddInstance(host?: string): Promise<void> {
p.intro("Add GitLab Instance");
// Get host
let instanceHost: string;
if (host) {
instanceHost = host;
} else {
const hostInput = await p.text({
message: "GitLab instance host:",
placeholder: "gitlab.company.com",
validate: value => {
if (!value || value.length < 1) {
return "Host is required";
}
// Allow: localhost, hostname, hostname.domain, IP addresses
const hostnamePattern =
/^([a-z0-9]([a-z0-9-]*[a-z0-9])?\.)*[a-z0-9]([a-z0-9-]*[a-z0-9])?$/i;
const ipv4Pattern = /^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/;
// Check IPv4 FIRST - if it looks like an IP, validate octet ranges
// This prevents values like "256.1.1.1" from passing as hostnames
const ipMatch = value.match(ipv4Pattern);
if (ipMatch) {
const octets = [ipMatch[1], ipMatch[2], ipMatch[3], ipMatch[4]].map(Number);
if (octets.every(o => o >= 0 && o <= 255)) {
return undefined;
}
return "IP address octets must be between 0 and 255";
}
// Check hostname pattern
if (hostnamePattern.test(value)) {
return undefined;
}
return "Invalid hostname or IP address format";
},
});
if (p.isCancel(hostInput)) {
p.cancel("Setup cancelled");
return;
}
instanceHost = hostInput;
}
// Get display name
const name = await p.text({
message: "Display name:",
placeholder: "Company GitLab",
initialValue: instanceHost,
});
if (p.isCancel(name)) {
p.cancel("Setup cancelled");
return;
}
// OAuth configuration
const configureOAuth = await p.confirm({
message: "Configure OAuth for this instance?",
initialValue: false,
});
if (p.isCancel(configureOAuth)) {
p.cancel("Setup cancelled");
return;
}
let oauth: GitLabInstance["oauth"];
if (configureOAuth) {
const clientId = await p.text({
message: "OAuth Application ID:",
validate: value => {
if (!value || value.length < 10) {
return "Application ID is required";
}
return undefined;
},
});
if (p.isCancel(clientId)) {
p.cancel("Setup cancelled");
return;
}
// Environment variable name for secret (sanitize all non-alphanumeric chars)
const envName = instanceHost.toUpperCase().replace(/[^A-Z0-9]/g, "_") + "_SECRET";
p.note(
`Store your OAuth secret in environment variable: ${envName}\n` +
`Add to docker-compose.yml environment section or use .env file.`,
"OAuth Secret"
);
oauth = {
clientId,
clientSecretEnv: envName,
};
}
// Default preset
const preset = await p.select({
message: "Default preset for this instance:",
options: [
{ value: "developer", label: "Developer (default)" },
{ value: "senior-dev", label: "Senior Developer" },
{ value: "full-access", label: "Full Access" },
{ value: "devops", label: "DevOps" },
{ value: "code-reviewer", label: "Code Reviewer" },
{ value: "readonly", label: "Read-Only" },
],
});
if (p.isCancel(preset)) {
p.cancel("Setup cancelled");
return;
}
// Save instance
const instance: GitLabInstance = {
host: instanceHost,
name,
oauth,
defaultPreset: preset,
};
addInstance(instance);
p.log.success(`Added instance: ${instanceHost}`);
p.outro("Instance configuration saved. Restart container to apply changes.");
}
/**
* Remove GitLab instance
*/
export function dockerRemoveInstance(host: string): void {
if (removeInstance(host)) {
console.log(`✓ Removed instance: ${host}`);
console.log("Restart container to apply changes.");
} else {
console.error(`✗ Instance not found: ${host}`);
}
}
/**
* Run docker subcommand
*/
export async function runDockerCommand(args: string[]): Promise<void> {
const { subcommand, subArgs } = parseDockerSubcommand(args);
switch (subcommand) {
case "status":
showStatus();
break;
case "init":
await initDocker();
break;
case "start":
dockerStart();
break;
case "stop":
dockerStop();
break;
case "restart":
dockerRestart();
break;
case "upgrade":
dockerUpgrade();
break;
case "logs": {
const follow = subArgs.includes("-f") || subArgs.includes("--follow");
const linesArg = subArgs.find(a => a.startsWith("--lines="));
const lines = linesArg ? parseInt(linesArg.split("=")[1], 10) : 100;
dockerLogs(follow, lines);
break;
}
case "add-instance":
await dockerAddInstance(subArgs[0]);
break;
case "remove-instance":
if (!subArgs[0]) {
throw new Error("Usage: gitlab-mcp docker remove-instance <host>");
}
dockerRemoveInstance(subArgs[0]);
break;
default:
console.log("GitLab MCP Docker Commands:\n");
console.log(" gitlab-mcp docker status Show container and instances status");
console.log(" gitlab-mcp docker init Initialize Docker configuration");
console.log(" gitlab-mcp docker start Start container");
console.log(" gitlab-mcp docker stop Stop container");
console.log(" gitlab-mcp docker restart Restart container");
console.log(" gitlab-mcp docker upgrade Pull latest image and restart");
console.log(" gitlab-mcp docker logs [-f] Show container logs");
console.log(" gitlab-mcp docker add-instance Add GitLab instance");
console.log(" gitlab-mcp docker remove-instance Remove GitLab instance");
break;
}
}
|