### Install and Configure Qartez MCP

Source: https://github.com/kuberstar/qartez-mcp/blob/main/README.md

Use 'make deploy' for non-interactive configuration of all detected IDEs, or 'make setup' for an interactive prompt. You can also specify a subset of IDEs to configure.

```bash
make deploy                          # Configure every detected IDE (non-interactive)
make setup                           # Same, but interactive checkbox prompt
qartez-setup --ide cursor,zed       # Configure specific IDEs only
```

--------------------------------

### Setup and run benchmark fixtures

Source: https://github.com/kuberstar/qartez-mcp/blob/main/benchmarks/README.md

Commands to build the indexer and initialize the benchmark environment for specific languages.

```bash
# Build the indexer once:
cargo build --release --bin qartez-mcp

# Clone + index every language:
./scripts/setup-benchmark-fixtures.sh

# Or only one:
./scripts/setup-benchmark-fixtures.sh typescript

# Or two:
./scripts/setup-benchmark-fixtures.sh go java
```

```bash
cargo run --release --bin benchmark -- \
    --project-root target/benchmark-fixtures/typescript \
    --filter qartez_find
```

--------------------------------

### Start Development Server

Source: https://github.com/kuberstar/qartez-mcp/blob/main/qartez-dashboard/web/README.md

Starts the development server for the Svelte project. Use the --open flag to automatically open the app in a new browser tab.

```sh
npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open
```

--------------------------------

### Install Qartez MCP from Source

Source: https://github.com/kuberstar/qartez-mcp/blob/main/README.md

Installs Qartez MCP by cloning the repository and building from source. Requires Rust MSRV 1.88 for unsupported platforms.

```bash
git clone https://github.com/kuberstar/qartez-mcp.git
cd qartez-mcp
make deploy
```

--------------------------------

### Onboarding to a New Codebase

Source: https://github.com/kuberstar/qartez-mcp/blob/main/docs/agent-guide.md

Get an overview of a new codebase using tools for file importance, stats, architecture documentation, complexity hotspots, code ownership, and blame information.

```bash
qartez_map top_n=10 
qartez_stats 
qartez_wiki 
qartez_hotspots limit=5 
qartez_knowledge level=module 
qartez_blame symbol_name=parse_config
```

--------------------------------

### Install Qartez MCP on macOS/Linux/WSL 2

Source: https://github.com/kuberstar/qartez-mcp/blob/main/README.md

Installs Qartez MCP using a curl command. Downloads pre-built binaries and configures IDEs.

```bash
curl -sSfL https://qartez.dev/install | sh
```

--------------------------------

### Targeted IDE Installation

Source: https://github.com/kuberstar/qartez-mcp/blob/main/README.md

Configure a specific subset of IDEs by listing them with the --ide flag.

```bash
qartez-setup --ide cursor,zed,claude
```

--------------------------------

### Initialize Qartez dashboard subcommand

Source: https://github.com/kuberstar/qartez-mcp/blob/main/CHANGELOG.md

This snippet shows the basic structure for launching the `qartez dashboard` subcommand, which starts a local web dashboard.

```rust
/// Starts the local-only web dashboard.
#[derive(Debug, Parser)]
#[clap(about = "Local-only web dashboard.")]
pub enum DashboardCommand {
    Start,
    Stop,
    Status,
    Open,
}

impl DashboardCommand {
    pub async fn run(self) -> Result<()> {
        match self {
            DashboardCommand::Start => dashboard::start().await?,
            DashboardCommand::Stop => dashboard::stop().await?,
            DashboardCommand::Status => dashboard::status().await?,
            DashboardCommand::Open => dashboard::open().await?,
        }
        Ok(())
    }
}
```

--------------------------------

### Recreate Project with Specific Configuration

Source: https://github.com/kuberstar/qartez-mcp/blob/main/qartez-dashboard/web/README.md

Recreate the current project using a specific template, TypeScript, and pnpm for installation.

```sh
pnpm dlx sv@0.15.1 create --template minimal --types ts --install pnpm .
```

--------------------------------

### Install Qartez MCP on Windows PowerShell

Source: https://github.com/kuberstar/qartez-mcp/blob/main/README.md

Installs Qartez MCP using a PowerShell command. Downloads pre-built binaries and configures IDEs.

```powershell
powershell -ExecutionPolicy Bypass -c "iwr https://raw.githubusercontent.com/kuberstar/qartez-mcp/main/install.ps1 -useb | iex"
```

--------------------------------

### Enable Analysis Tools

Source: https://github.com/kuberstar/qartez-mcp/blob/main/docs/tools.md

Use `qartez_tools` with the `enable` parameter to unlock specific tools. This example enables all tools within the 'analysis' tier.

```bash
qartez_tools enable=["analysis"]        # unlock all analysis tools
```

--------------------------------

### Run Qartez CLI Tool

Source: https://github.com/kuberstar/qartez-mcp/blob/main/README.md

Use any core or analysis tool directly from the terminal by specifying the tool name after 'qartez'. Examples include mapping, finding configuration, or analyzing code impact.

```bash
qartez map
qartez find Config
qartez impact src/server/mod.rs
```

--------------------------------

### Define explicit workspaces in .qartez/workspace.toml

Source: https://github.com/kuberstar/qartez-mcp/blob/main/docs/configuration.md

Use this file to include unrelated directories or define custom prefixes for projects in a monorepo-style setup.

```toml
[workspaces]
# Key = Alias/Prefix used in path results
# Value = Path to the project (absolute, relative, or ~/ expansion)
Core = "../qartez-core"
Legacy = "~/old-projects/v1"
```

--------------------------------

### Generate starter configuration

Source: https://github.com/kuberstar/qartez-mcp/blob/main/docs/configuration.md

Use the CLI to automatically generate a boundaries configuration file based on current clustering.

```bash
qartez_boundaries suggest=true write_to=".qartez/boundaries.toml"
```

--------------------------------

### Clone and Build Qartez MCP Project

Source: https://github.com/kuberstar/qartez-mcp/blob/main/CONTRIBUTING.md

Clone the repository, navigate into the project directory, and build the project using Cargo. This is the initial step for setting up your development environment.

```bash
git clone https://github.com/kuberstar/qartez-mcp.git
cd qartez-mcp
cargo build
cargo test
```

--------------------------------

### Clone, Build, and Test Qartez MCP

Source: https://github.com/kuberstar/qartez-mcp/blob/main/README.md

Clone the repository, build the project, and run tests locally.

```bash
git clone https://github.com/kuberstar/qartez-mcp.git
cd qartez-mcp
cargo build
cargo test
```

--------------------------------

### Create a New Svelte Project

Source: https://github.com/kuberstar/qartez-mcp/blob/main/qartez-dashboard/web/README.md

Use this command to initialize a new Svelte project with default settings.

```sh
npx sv create my-app
```

--------------------------------

### Update GitHub Actions workflow triggers

Source: https://github.com/kuberstar/qartez-mcp/blob/main/CHANGELOG.md

This change modifies the `deny.yml` workflow to trigger on pushes to `main`, `release/*` branches, and tags starting with `v`, ensuring license checks are performed earlier in the release process.

```yaml
on:
  push:
    branches:
      - main
      - 'release/*'
    tags:
      - 'v*'
```

--------------------------------

### Run Benchmarks for All Languages

Source: https://github.com/kuberstar/qartez-mcp/blob/main/README.md

Execute the benchmark harness against five pinned OSS fixtures including Rust, TypeScript, Python, Go, and Java. This command generates cross-language summaries and individual reports.

```bash
make bench-all
```

--------------------------------

### Qartez Project Structure Overview

Source: https://github.com/kuberstar/qartez-mcp/blob/main/README.md

This is a detailed breakdown of the Qartez project's directory and file organization. It covers the main source files, modules for indexing, graph analysis, Git integration, storage, CLI setup, and benchmarking.

```plaintext
src/
  main.rs                  Entry point: index, compute, start server
  lib.rs                   Library root (re-exports)
  cli.rs                   CLI argument parsing (19 subcommands)
  cli_runner.rs            CLI subcommand dispatcher
  config.rs                Project configuration and root detection
  error.rs                 Error types
  str_utils.rs             String utilities (stable floor_char_boundary polyfill)
  toolchain.rs             Toolchain detection (Cargo, npm, Go, etc.)
  watch.rs                 File watcher for incremental re-indexing
  guard.rs                 Modification guard evaluation engine
  embeddings.rs            Local embedding model for qartez_semantic (opt-in)
  server/
    mod.rs                 MCP server entrypoint - dispatches to per-tool handlers
    tools/                 30 per-tool handler modules (one file per MCP tool)
    prompts.rs             6 workflow prompt templates
    tiers.rs               Progressive tool disclosure (core/analysis/refactor/meta)
    cache.rs               Tree-sitter parse cache
    helpers.rs             Shared handler utilities
    overview.rs            Overview/map generation
    params.rs              Tool parameter structs
    treesitter.rs          Tree-sitter integration helpers
    mcp_instructions.md    Embedded MCP server instructions
  index/
    mod.rs                 Core indexing engine (full + incremental, import resolution)
    walker.rs              File discovery (respects .gitignore + .qartezignore)
    parser.rs              Tree-sitter parser pool
    symbols.rs             Symbols / imports / references + AST shape hashing
    languages/             37 language adapters (21 with cyclomatic complexity)
  graph/
    mod.rs                 Graph module root
    pagerank.rs            PageRank on import graph
    blast.rs               Blast radius BFS
    leiden.rs              Community detection (Leiden clustering)
    boundaries.rs          Architecture-boundary rules engine
    security.rs            Security rule engine (powers qartez_security)
    wiki.rs                Architecture wiki renderer
  git/
    mod.rs                 Git module root
    cochange.rs            Co-change pair mining
    diff.rs                Diff range analysis (for qartez_diff_impact)
    trend.rs               Complexity trend over git history
    knowledge.rs           Code authorship and bus-factor analysis
  storage/
    mod.rs                 Storage module root
    schema.rs              SQLite + FTS5 schema
    read.rs / write.rs     Query and mutation helpers
    models.rs              Row structs
  bin/
    setup.rs               Interactive IDE setup wizard (19 IDEs)
    guard.rs               PreToolUse modification guard
    benchmark.rs           Benchmark harness entry point
  benchmark/               Benchmark internals (cargo feature)
    profiles/              Per-language benchmark profiles (Rust, TS, Python, Go, Java)
    scenarios.rs           28 benchmark scenarios
    judge.rs               LLM-judge harness
    report.rs              Markdown / JSON report writers
    tokenize.rs            cl100k_base token accounting
scripts/                   Hook + snippet assets embedded by qartez-setup
benchmarks/fixtures.toml   Pinned OSS repos for multi-language benchmarks
reports/                   Generated benchmark.md / benchmark.json artifacts
```

--------------------------------

### View CLI usage

Source: https://github.com/kuberstar/qartez-mcp/blob/main/docs/configuration.md

General command structure for the Qartez CLI.

```text
qartez [OPTIONS] [COMMAND]
```

--------------------------------

### Enable Qartez Tools

Source: https://github.com/kuberstar/qartez-mcp/blob/main/README.md

Enable additional tiers of Qartez tools, such as 'analysis' or 'all', on demand.

```bash
qartez_tools enable: ["analysis"]
```

--------------------------------

### Clone and Index Fixture Repositories

Source: https://github.com/kuberstar/qartez-mcp/blob/main/README.md

Clone and index the pinned fixture repositories required for running benchmarks.

```bash
make bench-fixtures
```

--------------------------------

### Project Structure and Symbol Exploration

Source: https://github.com/kuberstar/qartez-mcp/blob/main/docs/agent-guide.md

Use `qartez_map` to understand the project's skeleton and top files by importance, or to explore top symbols. `qartez_stats` provides a metrics overview.

```bash
qartez_map 
qartez_map by=symbols 
qartez_stats
```

--------------------------------

### Enable All Tools

Source: https://github.com/kuberstar/qartez-mcp/blob/main/docs/tools.md

To unlock all available tools and tiers, use `qartez_tools` with `enable=["all"]`. This command enables everything accessible.

```bash
qartez_tools enable=["all"]             # unlock everything
```

--------------------------------

### Enable a Single Tool

Source: https://github.com/kuberstar/qartez-mcp/blob/main/docs/tools.md

This snippet demonstrates how to enable a single, specific tool, `qartez_refs`, using the `enable` parameter.

```bash
qartez_tools enable=["qartez_refs"]     # unlock a single tool
```