is installs CodeCompass globally. You can then run it from any directory. ## Usage CodeCompass can be run in two main modes: as a server (default) or as a client to execute specific tools against a running server. **1. Running the CodeCompass Server:** To start the CodeCompass server, navigate to the root of your git repository and run: ```bash codecompass [repoPath] [--port ] ``` - `[repoPath]` (optional): Path to the repository you want CodeCompass to analyze. If omitted, it defaults to the current directory (`.`). - `--port ` (optional): Specify the HTTP port for the server. This overrides the `HTTP_PORT` environment variable and the default port (3001). Examples: ```bash # Start server for the current directory on the default port codecompass # Start server for a specific repository codecompass /path/to/your/project # Start server for the current directory on port 3005 codecompass --port 3005 ``` Once started, CodeCompass will begin indexing your repository (if it hasn't already). MCP communication is primarily handled via `stdio`. A utility HTTP server also runs on the configured port (default 3001) for health checks, indexing status, and to receive repository update notifications from Git hooks. **Port Conflicts for Utility HTTP Server:** If the configured utility HTTP port is in use by another CodeCompass instance, the new instance will disable its own utility HTTP server and run with `stdio` MCP. Its utility-related MCP tools (like `get_indexing_status`, `trigger_repository_update`) will automatically relay requests to the existing instance's HTTP utility endpoints. If the port is taken by a non-CodeCompass service, the new instance will log an error and exit. Git hooks should generally target the HTTP port of the primary running CodeCompass instance. **2. Executing Tools via CLI Client Mode:** To execute specific tools, CodeCompass CLI spawns a dedicated server instance and communicates with it via `stdio` using the Model Context Protocol (MCP). ```bash codecompass [json_parameters] [--repo ] [--json] [--port ] ``` - ``: The name of the tool to execute (see list below). - `[json_parameters]` (optional): A JSON string containing parameters for the tool. For tools that take no parameters, this can be omitted or an empty JSON object `{}` can be used. - `--repo ` or `-r ` (optional): Specify the repository path for the tool's context. Defaults to the current directory (`.`). The spawned server will use this repository. - `--json` or `-j` (optional): Output the raw JSON response from the tool. Useful for scripting or debugging. - `--port ` (optional): Specify the utility HTTP port for the spawned server instance. This is primarily for consistency if the spawned server needs to interact with other instances or if its utility port needs to be specific, though core MCP communication for the tool is via `stdio`. **Available Tools for CLI Client Execution:** * `agent_query `: Orchestrates capabilities to answer complex queries. * Example: `codecompass agent_query '{"query": "How is user authentication handled?", "sessionId": "my-session-123"}'` * With JSON output: `codecompass agent_query '{"query": "Show me user models"}' --json` * `search_code `: Performs semantic code search. * Example: `codecompass search_code '{"query": "database connection setup"}'` * `get_changelog`: Retrieves the project's `CHANGELOG.md`. * Example: `codecompass get_changelog` * `get_indexing_status`: Gets the current status of repository indexing. (May be relayed if another CC instance is primary) * Example: `codecompass get_indexing_status --json` * `trigger_repository_update`: Triggers a re-indexing of the repository. (May be relayed) * Example: `codecompass trigger_repository_update` * `switch_suggestion_model `: Switches the suggestion model/provider. * Example: `codecompass switch_suggestion_model '{"model": "deepseek-coder", "provider": "deepseek"}'` * `get_sessio

CodeCompass

评论