Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
90 lines (62 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

90 lines (62 loc) · 1.76 KB

Contributing

Development Setup

git clone https://github.com/mkXultra/ai-cli-mcp.git
cd ai-cli-mcp
npm install
npm run build

Testing

# Run all tests
npm test

# Unit tests only
npm run test:unit

# Deterministic PR/release gate
npm run test:release

# Published npm package contents smoke test
npm run test:package

# E2E tests (with mocks)
npm run test:e2e

# E2E tests locally (requires Claude CLI)
npm run test:e2e:local

# Opt-in live E2E against real installed AI CLIs
ACM_LIVE_E2E=1 ACM_LIVE_E2E_SURFACE=all ACM_LIVE_E2E_AGENTS=claude,codex npm run test:live

# Watch mode
npm run test:watch

# Coverage
npm run test:coverage

Manual Testing with MCP Inspector

npm run build
npx @modelcontextprotocol/inspector node dist/server.js

CLI Direct Execution

Run AI CLI tools directly from the terminal (foreground, no MCP server):

npm run -s cli.run -- --model sonnet --workFolder /tmp --prompt "hello"

See docs/development.md for full options.

Local Development with npm link

npm install
npm run build
npm link

Then use ai-cli-mcp command globally.

Environment Variables

Variable Description
CLAUDE_CLI_NAME Claude CLI binary name or absolute path
CODEX_CLI_NAME Codex CLI binary name or absolute path
GEMINI_CLI_NAME Gemini CLI binary name or absolute path
MCP_CLAUDE_DEBUG Enable debug logging (true/false)

Release Process

See docs/RELEASE_CHECKLIST.md for release instructions.

Uses semantic-release with Conventional Commits:

  • fix: → patch release
  • feat: → minor release
  • feat!: or BREAKING CHANGE: → major release

License

MIT