Bash MCP (Master Control Program)

# Project Files This document provides a listing of all files in the Bash MCP project with a short description of each file's purpose. ## Root Directory - `MASTERPLAN.md` - Development roadmap and feature implementation plan - `README.md` - Project documentation, installation, and usage guide - `STATUS.md` - Current project status, completed features, and next steps - `package.json` - Node.js project configuration and dependencies - `package-lock.json` - Exact dependency tree for reproducible installations - `tsconfig.json` - TypeScript compiler configuration - `jest.config.js` - Jest testing framework configuration - `fix-lint.sh` - Shell script to automatically fix linting issues - `.prettierrc` - Prettier code formatter configuration - `.prettierignore` - Files to exclude from Prettier formatting - `.eslintrc.json` - ESLint configuration for code linting - `.eslintignore` - Files to exclude from ESLint - `.gitignore` - Files to exclude from Git version control ## Source Code (`src/`) ### Core Components - `src/index.ts` - Main entry point and public API for the module - `src/core/bash-mcp.ts` - Main BashMCP class implementation - `src/core/command-executor.ts` - Handles non-interactive command execution - `src/core/session-manager.ts` - Manages interactive sessions using pseudoterminals ### Types and Utilities - `src/types/index.ts` - TypeScript type definitions and interfaces - `src/utils/config.ts` - Configuration loading and validation - `src/utils/logger.ts` - Logging utilities using Winston - `src/utils/validator.ts` - Command and directory validation utilities ## Configuration (`config/`) - `config/default.json` - Default configuration for allowed commands, directories, and settings ## Examples (`examples/`) - `examples/basic-usage.ts` - Example code demonstrating basic Bash MCP usage ## Tests (`tests/`) ### Test Configuration - `tests/config/test-config.json` - Test-specific configuration ### Test Helpers - `tests/helpers/mocks.ts` - Mock objects and utilities for testing ### Core Tests - `tests/core/bash-mcp.test.ts` - Tests for the main BashMCP class - `tests/core/command-executor.test.ts` - Tests for the CommandExecutor class - `tests/core/session-manager.test.ts` - Tests for the SessionManager class ### Utility Tests - `tests/utils/config.test.ts` - Tests for configuration loading and validation - `tests/utils/validator.test.ts` - Tests for command and directory validation ### Integration Tests - `tests/integration/basic-flow.test.ts` - Integration tests for basic workflow ## Generated Directories - `dist/` - Compiled JavaScript output (generated by TypeScript) - `logs/` - Application logs directory - `coverage/` - Test coverage reports (generated by Jest) - `node_modules/` - npm dependencies