Colink

System Requirements

• Go: 1.25 or later
• Node.js: 20 or later
• npm
• Make
• Database: SQLite for local development, MySQL for production deployment

On Windows, use PowerShell or another terminal that can run make.

2. Build Backend Resources

make build
make genplugins
go build -o bin/mcp-server.exe ./cmd/mcp-server

make build already depends on plugin generation, but running make genplugins explicitly is useful when you want to refresh the local plugin registry before starting the application. Build mcp-server.exe before starting the backend so MCP-related functionality is available at runtime.

Quick Start

3. Prepare Configuration

Create a local config file from the example when the template exists:

if (Test-Path configs\config.yaml.example) {
  Copy-Item configs\config.yaml.example configs\config.yaml -Force
}

Then edit:

configs\config.yaml

Update database, server, agent, IM, and other runtime settings as needed. If this workspace already provides configs\config.yaml, edit that file directly.

Configuration Notes

• Runtime config file: configs\config.yaml
• Local SQLite database: data\sqlite\colink.db
• Backend server entry: cmd/server
• Migration tool entry: cmd/migrate
• Frontend app: web

When changing the config schema, keep the Go config definitions and example configuration in sync.

---

Quick Q&A

Q: Do I need MySQL for local development? A: No. Local development can use SQLite through data\sqlite\colink.db. MySQL is supported for production-style deployments.

Q: Why do I need to run migrations manually? A: The SQLite database must be upgraded through versioned migration directories under sql-change/ so the schema matches the current backend.

Q: Does make build generate plugins? A: Yes. The build target depends on genplugins. You can still run make genplugins manually to refresh plugin registry files.

Q: Which ports are used by default? A: The frontend runs on 3000 by default. The backend port is controlled by configs\config.yaml.

Q: Is Feishu an agent adapter? A: No. Feishu is an IM entry point. Agent execution still goes through Orchestrator -> ExecutionService -> Adapter.

---