Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions .github/workflows/LinkCheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: LinkCheck

on:
push:
branches:
- main
tags: ["*"]
pull_request:

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}

jobs:
link-checker:
name: Link checker
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6

- name: Link Checker
id: lychee
uses: lycheeverse/lychee-action@v2
with:
fail: true
args: --config '.lychee.toml' .
13 changes: 13 additions & 0 deletions .lychee.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
exclude = [
"@ref",
"@cite",
"^https://github.com/.*/releases/tag/v.*$",
"^https://doi.org/FIXME$",
"zenodo.org/badge/DOI/FIXME$",
# docs/src/*.md references like ./assets/kaimon_*.gif are rewritten by the
# VitePress plugin (docs/src/.vitepress/config.mts) to point at the
# docs-assets GitHub Release at build time; lychee can't see that rewrite.
"docs/src/assets/kaimon_.*\\.gif$",
]

exclude_path = ["docs/build"]
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ kaimon

The first run opens a setup wizard (security mode, API key, port). After that, the terminal dashboard launches:

![Kaimon dashboard](docs/src/assets/kaimon_overview.gif)
![Kaimon dashboard](https://github.com/kahliburke/Kaimon.jl/releases/download/docs-assets/kaimon_overview.gif)

From the dashboard:
- Press **`i`** in the Config tab to write MCP config for Claude Code, Cursor, VS Code, or Gemini CLI
Expand Down Expand Up @@ -99,7 +99,7 @@ Full documentation: [kahliburke.github.io/Kaimon.jl](https://kahliburke.github.i
- Julia 1.12+
- Any MCP-compatible client (Claude Code, Cursor, VS Code with MCP extension)
- Optional: [Qdrant](https://qdrant.tech) for semantic code search
- Optional: [VS Code Remote Control](https://marketplace.visualstudio.com/items?itemName=nicollasricas.vscode-remote-control) extension for VS Code integration
- Optional: [VS Code Remote Control](https://github.com/estruyf/vscode-remote-control) extension for VS Code integration (auto-installed by Kaimon's setup wizard)

## Contributing

Expand Down
2 changes: 1 addition & 1 deletion docs/src/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ The extension manager (`src/extension_manager.jl`) handles the lifecycle of `Man
## TUI Architecture

The terminal dashboard (`src/tui.jl` and `src/tui/`) is built on
[Tachikoma.jl](https://github.com/kburke/Tachikoma.jl), a Julia TUI
[Tachikoma.jl](https://github.com/kahliburke/Tachikoma.jl), a Julia TUI
framework. It follows the Elm architecture:

```mermaid
Expand Down
2 changes: 1 addition & 1 deletion docs/src/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ This is useful for restricting which operations MCP agents can perform in sensit

## TUI Configuration

The TUI (Terminal User Interface) built on [Tachikoma.jl](https://github.com/...) supports customization of:
The TUI (Terminal User Interface) built on [Tachikoma.jl](https://github.com/kahliburke/Tachikoma.jl) supports customization of:

- **Themes** -- Visual appearance of the TUI panels and widgets
- **Layouts** -- Panel arrangement, sizes, and visibility
Expand Down
4 changes: 2 additions & 2 deletions docs/src/extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ MyExtension.jl/
└── tui_panel.jl # optional TUI panel
```

See [`examples/HelloExtension.jl`](https://github.com/kburke/Kaimon.jl/tree/main/examples/HelloExtension.jl) for a complete working example with tools, push-based panel updates, and a shutdown hook.
See [`examples/HelloExtension.jl`](https://github.com/kahliburke/Kaimon.jl/tree/main/examples/HelloExtension.jl) for a complete working example with tools, push-based panel updates, and a shutdown hook.

### `kaimon.toml`

Expand Down Expand Up @@ -249,7 +249,7 @@ The `ctx` argument passed to `init`, `update!`, and `cleanup!` provides:

### Key Handling with @match

Use the `@match` macro (from [Match.jl](https://github.com/kmsquire/Match.jl), a Kaimon dependency) for clean dispatch:
Use the `@match` macro (from [Match.jl](https://github.com/JuliaServices/Match.jl), a Kaimon dependency) for clean dispatch:

```julia
using Match
Expand Down
2 changes: 1 addition & 1 deletion docs/src/tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ Provide `project_path` (absolute path to the project) or `session` to identify t

## Semantic Search (Qdrant)

Semantic search requires [Qdrant](https://qdrant.tech/) running locally and [Ollama](https://ollama.ai/) for embeddings. The default embedding model is `qwen3-embedding:0.6b`.
Semantic search requires [Qdrant](https://qdrant.tech/) running locally and [Ollama](https://ollama.com/) for embeddings. The default embedding model is `qwen3-embedding:0.6b`.

| Tool | Description | Key Parameters |
|------|-------------|----------------|
Expand Down